Retrieve the points ranking

Returns the users ranked by points earned in the selected period. When period is omitted, all-time points are used; when limit is omitted, up to 100 positions are returned.

Results are limited to the products and users accessible with the current credentials. Filtering by product_id narrows that scope and never widens it: requesting products outside the scope returns an empty ranking.

Each entry includes the user's name and avatar only when the credentials also have the users.read permission; otherwise the user object is null.

Rankings are eventually consistent. Manual point adjustments are reflected on the next request, while automatically awarded points may take up to cache_ttl_seconds to appear.

Query Parameters

Response Body

curl -X GET "https://example.com/gamification/rankings"

{  "data": {    "cache_ttl_seconds": 0,    "entries": [      {        "points": 0,        "position": 0,        "user": {          "avatar": "string",          "name": "string"        },        "user_id": "string"      }    ],    "generated_at": "2019-08-24T14:15:22Z",    "object": "ranking",    "period": {      "from": "2019-08-24T14:15:22Z",      "kind": "all",      "to": "2019-08-24T14:15:22Z"    },    "scope": {      "product_ids": [        "string"      ]    },    "summary": {      "participants": 0,      "total_points": 0    }  }}