Skip to main content
GET
/
streaks
JavaScript
import { TrophyApiClient } from '@trophyso/node';

const response = await trophy.streaks.list({
  userIds: ['user-123', 'user-456', 'user-789']
});
[
  {
    "userId": "user-123",
    "streakLength": 15,
    "extended": "2025-01-01T05:03:00Z"
  },
  {
    "userId": "user-456",
    "streakLength": 12,
    "extended": "2025-01-01T08:43:00Z"
  },
  {
    "userId": "user-789",
    "streakLength": 0,
    "extended": null
  }
]

Authorizations

X-API-KEY
string
header
required

Query Parameters

userIds
string[]
required

A list of up to 100 user IDs.

Response

Successful operation

userId
string
required

The ID of the user.

streakLength
integer
required

The length of the user's streak.

extended
string
required

The timestamp the streak was extended, as a string.

I