Get a user's streak status

Get a user’s streak data.

GET /users/{id}/streak

JavaScript

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await trophy.users.streak("user-id", {
  historyPeriods: 14
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.users.streak(id="user-id", history_periods=14)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Users.Streak(
  context.TODO(),
  "user-id",
  &api.UsersStreakRequest{},
)

curl --request GET \
  --url https://api.trophy.so/v1/users/{id}/streak \
  --header 'X-API-KEY: <api-key>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trophy.so/v1/users/{id}/streak",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.trophy.so/v1/users/{id}/streak")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trophy.so/v1/users/{id}/streak")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "length": 1,
  "frequency": "weekly",
  "started": "2025-04-02",
  "periodStart": "2025-03-31",
  "periodEnd": "2025-04-05",
  "expires": "2025-04-12",
  "extended": "2025-04-03T14:30:00Z",
  "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
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Headers

Tenant-ID · string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

id · string · required

ID of the user.

Query Parameters

historyPeriods · integer · default: 7

The number of past streak periods to include in the streakHistory field of the response.

Response

200

application/json

Successful operation

An object representing the user's streak.

length · integer · required

The length of the user's current streak.

frequency · enum<string> · required

The frequency of the streak.

Available options: daily, weekly, monthly

started · string<date> | null · required

The date the streak started.

periodStart · string<date> | null · required

The start date of the current streak period.

periodEnd · string<date> | null · required

The end date of the current streak period.

expires · string<date> | null · required

The date the streak will expire if the user does not increment a metric.

extended · string<date-time> | null · required

The timestamp the streak was most recently extended. Null if the streak is not active.

streakHistory · object[] · required

A list of the user's past streak periods up through the current period. Each period includes the start and end dates and the length of the streak.

Show child attributes

freezes · integer

The number of available streak freezes. Only present if the organization has enabled streak freezes.

maxFreezes · integer

The maximum number of streak freezes a user can have. Only present if the organization has enabled streak freezes.

freezeAutoEarnInterval · integer

The interval at which the user will earn streak freezes, in days. Only present if the organization has enabled streak freeze auto-earn.

freezeAutoEarnAmount · integer

The amount of streak freezes the user will earn per interval. Only present if the organization has enabled streak freeze auto-earn.