Skip to main content
GET
Query Account Usage

Authorizations

X-Access-Key
string
header
required

API key authentication

Query Parameters

granularity
enum<string>
default:day

Time granularity: day or month

Available options:
day,
month
startTime
string<date>

Start date (format: yyyy-MM-dd)

Example:

"2026-06-01"

endTime
string<date>

End date (format: yyyy-MM-dd)

Example:

"2026-06-16"

groupBy
enum<string>
default:org

Group by fields (comma-separated): endpoint, user, or org

Available options:
endpoint,
user,
org
Example:

"endpoint,user"

Response

Successful response

success
boolean

Request success or not

code
integer

Response code (1 for success, other numbers for errors)

msg
string

SUCCESS or error message

data
object[]

Array of account usage data