Get single tag value

Fetches the value of a specific tag identified by its name, along with optional filters for time range and conditions.

Last Update: 7 NOV 2024

Example URL

https://{api_base_url}/integration/webapi/tag/B15-Status/value?starttime=*-10d&endtime=*&query=value > 50

Note: This endpoint demonstrates querying the value of a specific tag (B15-Status) with additional query parameters. In this example:

• starttime=*-10d specifies the start time as 10 days ago.

• endtime=* indicates no specific end time (or the most recent data).

• query=value > 50 filters the results to include only those where the value is greater than 50.

Retrieve Tag Value with Conditions

Method: GET

URL: {{base_url}}/tag/{tagname}/value?starttime={starttime}&endtime={endtime}&query={query}

---

Query Parameters:

Parameter	Required	Description
starttime	Yes	Starting time for filtering the data (e.g., *-10y) (Default: starttime=*-10m)
endtime	Yes	Ending time for filtering the data (e.g., *) (Default: endtime=*)
query	No	A condition to filter the results, acting like a WHERE clause in PostgreSQL.

Time Expression:

Expression	Description
sec	Second
m	Minute
h	Hour
d	Day
mo	Month
y	Year
*	Present
-	Go back (e.g., *-10y means go back 10 years)
+	Go forward (e.g., *+10mo means go forward 10 months)

---

Response Example:

{
    "data": [
        {
            "tagname": "string",
            "description": "string or null",
            "subDescription": "string or null",
            "value": "string",
            "quality": integer,
            "status": integer,
            "timeStamp": "datetime"
        }
    ]
}

Response Details:

Object	Data Type	Description
data	array	Array of tag value objects returned from the API.
tagname	string	Name of the tag.
description	string/null	Description of the tag, if available.
subDescription	string/null	Sub-description of the tag, if available.
value	string	Current value of the tag.
quality	integer	Quality indicator of the tag value.
status	integer	Status code associated with the tag value.
timeStamp	datetime	Timestamp when the tag value was recorded.