Get top ranked users

get

https://{host}/api_gateway/intouch-api-v3/v3.1/leaderboards/targetGroups/{targetGroupId}

Path Params

targetGroupId

string

required

Query Params

targetId

int64

required

The ID of the target. A target is a set of conditions or rules that need to be met to achieve a specific goal.

periodId

int64

The period ID of the target. A period is a set of parameters that define the timeframe for a target. If periodId is not provided, the current period of the target group will be used.

pageSize

int32

The number of results required. For example, to view the top five ranks only, set the value to 5.

pageOffset

int32

The start page from which data retrieval starts. This value should not be negative. For example, a value of 5 indicates that data retrieval will begin from the 5th page.

pageLimit

int32

Number of pages from which results are displayed. A maximum of 100 pages can be viewed in one request.

Headers

DATA-SCOPE-ORG

string

List of Organisation IDs

DATA-SCOPE

string

Scopes define what data can be accessed using the API. You can use scopes to control access to data from a parent or child organisation. Defining a scope ensures that the response contains only data from the respective organisation. Supported headers: SELF, OTHER and ALL.

Responses

Language

Credentials

Basic

base64

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400