Skip to content
OTA-Pulse Docs

Get Device Metric Timeseries

GET
/api/metrics/device/{device_id}/timeseries
 
curl --request GET \
  --url 'https://example.com/api/metrics/device/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/timeseries?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&name=example&interval=5m&aggregation=avg' \
  --header 'Authorization: Bearer <token>'

Get time series data for a metric with aggregation

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
device_id
required
Device Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid
name
required
Name
string
start_time
Any of:
string format: date-time
end_time
Any of:
string format: date-time
interval
Interval
string
default: 5m /^\d+[mhd]$/
aggregation
Aggregation
string
default: avg /^(avg|min|max|sum|count)$/

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
MetricTimeSeriesResponse

Time series data for a metric

object
data
required
Data
Array<object>
object
key
additional properties
any
name
required
Name
string
unit
required
Any of:
string
Example generated 
{
  "data": [
    {}
  ],
  "name": "example",
  "unit": "example"
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}