Get top usage metrics

GET

/dashboard/usage

Get top billable metrics by usage volume in the given period.

Parameters

Query Parameters

start_date

Any of:

string

string format: date

null

null

Period start date (YYYY-MM-DD)

end_date

Any of:

string

string format: date

null

null

Period end date (YYYY-MM-DD)

Responses

200

Successful Response

UsageMetricsResponse

object

top_metrics

required

Top Metrics

Array<object>

UsageMetricVolume

object

metric_name

required

Metric Name

string

metric_code

required

Metric Code

string

event_count

required

Event Count

integer

401

Unauthorized – invalid or missing API key

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object