API Reference

get usage metric

post
https://live.kable.io/api/v1/usage/get

Retrieve a usage metric for a given dimension from Kable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The aggregation by which to evaluate the metric.

Allowed:
string

The dimension to measure.

Note that one of either dimensionId or dimensionKey must be provided.

string

The dimension to measure.

Note that one of either dimensionId or dimensionKey must be provided.

date-time
required

Start of the period over which to query. Timestamps must be formatted as RFC 3339 strings like 2022-01-09T09:32:01Z.

date-time
required

End of the period over which to query. Timestamps must be formatted as RFC 3339 strings like 2022-01-09T09:32:01Z.

string
enum
required

Timeseries unit duration over which to return intervals.

Allowed:
string

When provided, query will consider only this customer. When null, query will consider all of your customers.

Headers
string
required

Your Kable client ID, found in the dashboard of your Kable account.

string
required

Your LIVE or TEST secret key.

Responses

Updated over 3 years ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago