GET
Get Overview

Authorizations

Authorization
string
header
required

An EESI API key (sk-eesi-...) or a Clerk session token.

Headers

authorization
string | null
X-API-Key
string | null

Query Parameters

days
integer
default:30

Window length in days

Required range: 1 <= x <= 365

Response

Successful Response

window
AdminWindow · object
required
metrics
Metrics · object
required
live
Live · object
required
lifetime
Lifetime · object
required
daily
SeriesPoint · object[]
required
plans
Plans · object[]
required
top_organizations
Top Organizations · object[]
required
top_users
Top Users · object[]
required
rate_card
Rate Card · object
minutes
Minutes · object
lifetime_minutes
Lifetime Minutes · object
daily_previous
SeriesPoint · object[]