Get tag history for a booth

GET /api/booths/{id}/history
Api key

Allows you to retrieve the history of a specific tag for a particular booth under your account within a certain date range.

Path parameters

  • id string Required

    id of the booth

Query parameters

  • tag string Required

    the name of the tag for which to get historic data

  • start string Required

    an ISO8601 formatted date to query data from

  • datapoints string

    the number of datapoints to return

  • end string Required

    an ISO8601 formatted date to query data until

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data array[object]

      Historic tag data

      Hide data attributes Show data attributes object
      • system_time string

        ISO8601 encoded timestamp

      • value number

        Value of the tag at the given timestamp
  • 400 application/json

    Bad request

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
GET /api/booths/{id}/history 
curl \
 --request GET 'http://localhost:4000/api/booths/{id}/history?tag=string&start=string&end=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "value": 0.5,
      "system_time": "2023-09-06T00:00:00Z"
    }
  ]
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}