Rewards

Get rewards summery

post

This API retrieves the total rewards earned by users for tasks completed during a specified reporting period. The reporting period can either be provided in the request (date_from and date_to) or defaults to the last closed reporting period if not specified. Rewards are only included for tasks marked with is_reporting_period_closed = true.

Notes:

• If date_from and date_to are provided, the system calculates rewards for all full calendar months within the range and returns the total for those months

• If no period is specified, the API defaults to the last closed reporting period

• Pagination is required when external_user_ids is not specified, as the response includes data for all users

• Rewards are only included for tasks with is_reporting_period_closed = true

Authorizations

PublicApiKey

x-api-keystringRequired

Query parameters

date_fromstring · date-timeOptional

The start date of the reporting period in ISO 8601 format.

date_tostring · date-timeOptional

The end date of the reporting period in ISO 8601 format.

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

external_user_idsstring[]Optional

An array of unique identifiers assigned to users by an external system or third-party service. If not provided, the response includes data for all users in the system.

Example: ["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8","6ba7b811-9dad-11d1-80b4-00c04fd430c8"]

Responses

201Success

application/json

currencyobject · nullableRequired

The type of currency or unit used for rewards (e.g., USD, coins).

Example: USD

429

Returned when the rate limit is exceeded

post/api/v1/public/rewards/summary

HTTPcURLJavaScriptPython

POST /api/v1/public/rewards/summary HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "external_user_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
  ]
}

{
  "period": {
    "date_from": "2024-01-01T09:05:22.553Z",
    "date_to": "2024-01-31T09:05:22.553Z"
  },
  "currency": "USD",
  "users_rewards": [
    {
      "user": {
        "id": "84567-83652",
        "external_user_id": "74893u7i8byed",
        "name": "Alia Simple",
        "email": "[e-mail]",
        "status": "Active"
      },
      "reward": 500,
      "time_spent": 456789
    },
    {
      "user": {
        "id": "84567-83653",
        "external_user_id": "74893u7i8byee",
        "name": "John Doe",
        "email": "[e-mail]",
        "status": "Active"
      },
      "reward": 750,
      "time_spent": 623456
    }
  ]
}