cURL
curl --request GET \ --url https://app.trophy.so/api/users/{id}/streak \ --header 'X-API-KEY: <api-key>'
{ "length": 1, "frequency": "weekly", "started": "2025-04-02", "periodStart": "2025-03-31", "periodEnd": "2025-04-05", "expires": "2025-04-12", "streakHistory": [ { "periodStart": "2025-03-30", "periodEnd": "2025-04-05", "length": 1 }, { "periodStart": "2025-04-06", "periodEnd": "2025-04-12", "length": 2 }, { "periodStart": "2025-04-13", "periodEnd": "2025-04-19", "length": 3 }, { "periodStart": "2025-04-20", "periodEnd": "2025-04-26", "length": 0 }, { "periodStart": "2025-04-27", "periodEnd": "2025-05-03", "length": 1 }, { "periodStart": "2025-05-04", "periodEnd": "2025-05-10", "length": 2 }, { "periodStart": "2025-05-11", "periodEnd": "2025-05-17", "length": 3 } ] }
Get a user’s streak data.
ID of the user.
The number of past streak periods to include in the streakHistory field of the response.
Successful operation
An object representing the user's streak.
Was this page helpful?