Restore streaks for multiple users

Restore streaks for multiple users to the maximum previously achieved streak length found within the current restore window: the last 90 days for daily streaks, weekly periods starting with the week containing the start of the current calendar year for weekly streaks, and monthly periods starting at the beginning of the previous calendar year for monthly streaks.

POST /streaks/restore

JavaScript

JavaScript

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

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

const response = await trophy.admin.streaks.restore({
  users: [{ id: 'user-123' }, { id: 'user-456' }]
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.admin.streaks.restore({
  "users": [{"id": "user-123"}, {"id": "user-456"}]
})

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.Admin.Streaks.Restore(context.TODO(), nil)

curl --request POST \
  --url https://admin.trophy.so/v1/streaks/restore \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "users": [
    {
      "id": "user-123"
    },
    {
      "id": "user-456"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/streaks/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'users' => [
        [
                'id' => 'user-123'
        ],
        [
                'id' => 'user-456'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.post("https://admin.trophy.so/v1/streaks/restore")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"users\": [\n    {\n      \"id\": \"user-123\"\n    },\n    {\n      \"id\": \"user-456\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/streaks/restore")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"users\": [\n    {\n      \"id\": \"user-123\"\n    },\n    {\n      \"id\": \"user-456\"\n    }\n  ]\n}"

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

200

Success with warnings

{
  "restoredUsers": [],
  "issues": [
    {
      "userId": "user-123",
      "severity": "warning",
      "message": "No streak to restore"
    }
  ]
}

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. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Body

application/json

Array of users to restore streaks for

Request body for restoring streaks for multiple users.

users · object[] · required

Array of users to restore streaks for. Maximum 100 users per request.

Required array length: 1 - 100 elements

Show child attributes

Example:

[{ "id": "user-123" }, { "id": "user-456" }]

Response

200

application/json

Successful operation (no streaks restored)

Response containing restored users and any issues encountered.

restoredUsers · string[] · required

Array of user IDs whose streaks were successfully restored.

Example:

["user-123", "user-456"]

issues · AdminIssue · object[] · required

Array of issues encountered during streak restoration.

Show child attributes