Skip to content

Ingest Metrics

POST
/api/v1/metrics
curl --request POST \
--url https://example.com/api/v1/metrics \
--header 'X-API-Key: example' \
--header 'X-Device-ID: example'

Ingest metrics from device.

Each organization may use at most metrics_max_names_per_org (200) distinct metric names (abuse cap, not a pricing dimension). A batch with names beyond the cap is still accepted (HTTP 200) for the points whose names are known or fit; the rest are dropped and the response adds metrics_dropped (count) and dropped_reason: "metric_name_cap" next to metrics_received. Only accepted points are metered for billing.

X-Device-ID
required
X-Device-Id
string
X-API-Key
required
X-Api-Key
string

Successful Response

Media type application/json
Example generated
example

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