Skip to main content
GET
Tenant usage analytics

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Query Parameters

days
enum<integer>
default:30

Legacy form: N whole UTC days ending with today so far. Cannot be combined with from/to. Any value outside the enum — including a repeated parameter — is a 400 rather than a silent fall back to the default.

Available options:
7,
30,
90
from
string<date-time>

Window start, inclusive. Strict ISO-8601 (must round-trip). Requires to. Must be on or after 2000-01-01T00:00:00.000Z.

to
string<date-time>

Window end, EXCLUSIVE. Strict ISO-8601. Requires from, must be later than it, and may not be more than 24 hours ahead of the server clock. A window ending in the future gap-fills its trailing buckets with zeros.

bucket
enum<string>
default:day

Series granularity, aligned to UTC calendar boundaries (weeks start Monday). A window yielding more than 400 buckets is rejected.

Available options:
hour,
day,
week,
month
initiator
string

Spender reference :, where type is one of oauth_member, end_user, agent_connection, credential, unattributed. The id is the identity analytics ranks by (external user id, Cognito sub, agent-connection id, or API key id); unattributed takes no id.

provider
string

Provider label as analytics reports it, including the literal 'Unknown service' for burns whose provider was never captured.

endpoint
string

Endpoint name. Requires provider.

limit
integer
default:10

Row cap applied to services, providers, users, and initiators.

Required range: 1 <= x <= 100

Response

Usage, cost, margin, service, and account rollups

success
any
required
analytics
object
required