v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get top ranked users

get/api_gateway/intouch-api-v3/v3.1/leaderboards/targetGroups/{targetGroupId}

Path parameters

targetGroupIdstring required

Query parameters

targetIdinteger 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.

periodIdinteger

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.

pageSizeinteger

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

pageOffsetinteger

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.

pageLimitinteger

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

Headers

DATA-SCOPE-ORGstring

List of Organisation IDs

DATA-SCOPEstring

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.

Response

200