Skip to main content
GET
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

range
enum<string>
default:1y

Time range to aggregate: last day, 7 days, 30 days, or year. Defaults to 1y.

Available options:
1d,
7d,
30d,
1y

Response

Retrieve insights

id
string<uuid> | null
required
status
enum<string> | null
required
Available options:
syncing,
ready,
failed,
null
rangeStart
string<date-time> | null
required
rangeEnd
string<date-time> | null
required
lastSyncedAt
string<date-time> | null
required
enabled
boolean
required
data
object | null
required