Skip to content
OTA-Pulse Docs

Get Device Metrics

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

Get metrics for a device

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
Any of:
string
start_time
Any of:
string format: date-time
end_time
Any of:
string format: date-time
limit
Limit
integer
default: 100 >= 1 <= 1000

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Response Get Device Metrics Api Metrics Device Device Id Get
Array<object>
MetricResponse

Single metric response

object
device_id
required
Device Id
string format: uuid
id
required
Id
string format: uuid
name
required
Name
string
tags
required
Tags
object
key
additional properties
string
timestamp
required
Timestamp
string format: date-time
unit
required
Any of:
string
value
required
Value
number
Example generated 
[
  {
    "device_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "tags": {
      "additionalProperty": "example"
    },
    "timestamp": "2026-04-15T12:00:00Z",
    "unit": "example",
    "value": 1
  }
]

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"
    }
  ]
}