Streaks
Read one streak
GET
/v1/streaks/{streakKey}The same streak the list returns, for a client showing one on a screen of its own. A streak that does not exist, is switched off, or is hidden from this player is the same 404, so one cannot be told from another.
Authorization
ApiKey AuthorizationBearer <token>
Paste a project API key (no 'Bearer ' prefix). Create one in the dashboard under API keys.
In: header
Path Parameters
streakKey*string
Query Parameters
PlayerId?string
Your own id for the player.
LanguageCode?string
Preferred locale for streak text; null = each text's default locale.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/streaks/string"{ "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 } ]}