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

Unique key of the metric.

Response

Successful operation

id
string
required

The unique ID of the metric.

Example:

"d01dcbcb-d51e-4c12-b054-dc811dcdc623"

key
string
required

The unique key of the metric.

Example:

"words-written"

name
string
required

The name of the metric.

Example:

"Words written"

current
number<double>
required

The user's current total for the metric.

Example:

1500

achievements
UserAchievementResponse · object[]
required

A list of the metric's achievements and the user's progress towards each.