Query a usage report

Query a usage report.

Authorization

bearerAuth

AuthorizationBearer <token>

JWT token from authentication

In: header

Header Parameters

Endless-Api-Version?string

Pin the caller to an API major (1). Omit to accept the current version. A major this deployment cannot serve is refused with 400 unsupported_api_version.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organization_ids*|array<>

The organizations the report covers. The caller must reach every one; all is staff-only.

metrics*array<>

The first metric orders a ranking and a breakdown.

Items1 <= items

group_by?string

Default"none"

Value in

"none"
"day"
"week"
"month"
"user"
"workspace"
"team"
"feature"
"model"
"output_type"
"status"
"provider"
"source"
"credit_type"
"channel"

period*|||

timezone?string

Day, week and month buckets and the period edges use this zone.

Default"UTC"

filters?

Default{}

limit?integer

Rows in a ranking or a breakdown.

Range1 <= value <= 100

Default10

Response Body

`application/json`

curl -X POST "https://example.com/reports/query" \  -H "Content-Type: application/json" \  -d '{    "organization_ids": "all",    "metrics": [      "credits_spent"    ],    "period": {      "kind": "last_days",      "days": 1    }  }'

{  "audience": "all",  "period": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "timezone": "string",    "earlier_cycle": true  },  "result": {    "shape": "kpi",    "values": {      "property1": 0,      "property2": 0    }  }}

Query a usage report

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

409application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`