Skip to main content
GET
Drill into a usage row

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

section
string
required

Which usage section to drill into.

Example:

"resolutions"

row_key
string
required

Which row within it, taken from that row's key.

Example:

"knowledge"

per_page
integer

Events per page.

cursor
string

Opaque cursor from the previous page.

period
enum<string>

Named reporting window. Defaults to month.

Available options:
day,
week,
month,
quarter,
year,
custom
Example:

"month"

from
string

Start of a custom window, ISO-8601. Required when period=custom.

to
string

End of a custom window, ISO-8601. Required when period=custom.

Response

Success

The row's events, with the same period envelope as the usage endpoint.