Skip to content

Get a single usage-metric by id

GET
/usage-metrics/{id}
id
required
string

DocumentId

OK

object
data
object
metric_name
required
string
interval
string
Allowed values: hourly daily weekly monthly
value
required
number
value_min
number
value_max
number
sample_count
integer
period_start
required
string format: date-time
period_end
required
string format: date-time
dimension
string
organisation
One of:

DocumentId reference to api::organisation.organisation

string
idempotency_key
string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found