Streaks

List a player's streaks

GET/v1/streaks

Lists the player's streaks: the live run, the longest they have reached, whether today already counts, when the run dies if they do nothing, and the milestone they are working toward.

AuthorizationBearer <token>

Paste a project API key (no 'Bearer ' prefix). Create one in the dashboard under API keys.

In: header

Query Parameters

PlayerId?string
LanguageCode?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/streaks"
[  {    "streakKey": "string",    "name": "string",    "description": null,    "images": {      "property1": "string",      "property2": "string"    },    "status": "NotStarted",    "isLocked": true,    "currentCount": 0,    "longestCount": 0,    "lastQualifyingDate": null,    "runExpiresAtUtc": null,    "nextMilestoneThreshold": null,    "milestones": [      {        "threshold": 0,        "isReached": true,        "rewards": [          {            "kind": "Points",            "pointsAmount": null,            "catalogItemKey": null,            "catalogItemValue": null          }        ],        "repeatsAfterReset": true      }    ]  }]