Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

id
string
required

ID of the user.

key
string
required

Key of the points system.

Query Parameters

aggregation
enum<string>
required

The time period over which to aggregate the event data.

Available options:
daily,
weekly,
monthly
startDate
string<date>
required

The start date for the data range in YYYY-MM-DD format. The startDate must be before the endDate, and the date range must not exceed 400 days.

endDate
string<date>
required

The end date for the data range in YYYY-MM-DD format. The endDate must be after the startDate, and the date range must not exceed 400 days.

Response

Successful operation

date
string<date>
required

The date of the data point. For weekly or monthly aggregations, this is the first date of the period.

Example:

"2024-01-01"

total
number<double>
required

The user's total points at the end of this date.

Example:

100

change
number<double>
required

The change in the user's total points during this period.

Example:

50