Telemetry

Get raw telemetry data

get

Path parameters

hidstringRequired

Object HID

sidstringRequired

Object SID

pidstringRequired

Object PID

insstringRequired

Object INS

ridstringRequired

Object RID

Query parameters

startstringRequired

Start date and time for telemetry data

endstringRequired

End date and time for telemetry data

limitnumberOptional

Limit the number of telemetry data points returned

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/historian/v3/telemetry/raw/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

GET /api/historian/v3/telemetry/raw/{hid}/{sid}/{pid}/{ins}/{rid}?start=text&end=text HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    {
      "ts": "text",
      "value": "text",
      "type": "text"
    }
  ]
}

Get numeric telemetry data

get

Path parameters

hidstringRequired

Object HID

sidstringRequired

Object SID

pidstringRequired

Object PID

insstringRequired

Object INS

ridstringRequired

Object RID

Query parameters

intervalnumberRequired

Interval in seconds for downsampling

startstringRequired

Start date and time for telemetry data

endstringRequired

End date and time for telemetry data

includeMinstringOptional

Include minimum value in the response

includeMaxstringOptional

Include maximum value in the response

offsetstring · enumOptional

Offset for within the interval for sampling values

Possible values:

limitnumberOptional

Limit the number of telemetry data points returned. This will always be the most recent data points

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/historian/v3/telemetry/numeric/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

GET /api/historian/v3/telemetry/numeric/{hid}/{sid}/{pid}/{ins}/{rid}?interval=1&start=text&end=text HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    {
      "ts": "text",
      "value": 1,
      "min": 1,
      "max": 1
    }
  ]
}

Get boolean telemetry data

get

Path parameters

hidstringRequired

Object HID

sidstringRequired

Object SID

pidstringRequired

Object PID

insstringRequired

Object INS

ridstringRequired

Object RID

Query parameters

intervalnumberRequired

Interval in seconds for downsampling

startstringRequired

Start date and time for telemetry data

endstringRequired

End date and time for telemetry data

offsetstring · enumOptional

Offset for within the interval for sampling values

Possible values:

limitnumberOptional

Limit the number of telemetry data points returned. This will always be the most recent data points

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/historian/v3/telemetry/boolean/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

GET /api/historian/v3/telemetry/boolean/{hid}/{sid}/{pid}/{ins}/{rid}?interval=1&start=text&end=text HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    {
      "ts": "text",
      "value": true
    }
  ]
}

Get telemetry data for multiple resources of an object

post

Path parameters

hidstringRequired

Object HID

sidstringRequired

Object SID

pidstringRequired

Object PID

insstringRequired

Object INS

Query parameters

intervalnumberRequired

Interval in seconds for downsampling

startstringRequired

Start date and time for telemetry data

endstringRequired

End date and time for telemetry data

includeMinstringOptional

Include minimum value in the response

includeMaxstringOptional

Include maximum value in the response

offsetstring · enumOptional

Offset for within the interval for sampling values

Possible values:

limitnumberOptional

Limit the number of telemetry data points returned. This will always be the most recent data points

includeNamestringOptional

Include resource name in the response

Body

application/json

ridsstring[]Required

Array of RIDs to get telemetry data for

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

post

/api/historian/v3/telemetry/object/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

POST /api/historian/v3/telemetry/object/{hid}/{sid}/{pid}/{ins}?interval=1&start=text&end=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "rids": [
    "text"
  ]
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    {
      "ts": "text",
      "resources": [
        {
          "rid": "text",
          "name": "text",
          "value": 1,
          "min": 1,
          "max": 1
        }
      ]
    }
  ]
}