Skip to main content
GET
Get Analytics Overview

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.

Query Parameters

bucket
enum<string>
default:day

Time bucket granularity for the returned series. Defaults to day.

Available options:
day,
week,
month
start
string<date-time>

Inclusive start of the range as an ISO 8601 timestamp. Defaults to 30 days before end.

end
string<date-time>

Exclusive end of the range as an ISO 8601 timestamp. Defaults to the current time.

Response

Successful response

Aggregated activity and usage metrics for an organization over a time range

bucket
enum<string>
required

Time bucket granularity of the returned series

Available options:
day,
week,
month
start
string<date-time>
required

Inclusive start of the range as an ISO 8601 timestamp

end
string<date-time>
required

Exclusive end of the range as an ISO 8601 timestamp

points
object[]
required
summary
object
required

Totals across the requested range

sources
object[]
required
usage
object[]
required