Skip to main content
GET
Get the analytics summary

Authorizations

Authorization
string
header
required

A workspace API key: Authorization: Bearer osk_...

Path Parameters

workspace
string<uuid>
required

Your workspace UUID. Must match the API key's workspace.

Query Parameters

period
enum<string>
default:this_month

In UTC. Weeks start on Monday. this_week, this_month and this_year run up to today; last_3_months is the three whole months before this one. Ignored when date_from and date_to are both sent.

Available options:
this_week,
last_week,
this_month,
last_month,
last_3_months,
this_year
date_from
string<date>

Start of a custom range (UTC day). Send with date_to.

Example:

"2026-01-01"

date_to
string<date>

End of a custom range, on or after date_from. A range spans at most 366 days, both ends included.

Example:

"2026-01-31"

Response

Success

period
object

The range the figures cover, and the previous range of the same length every change is measured against.

data
object