TAtalon
Achievements

List achievements

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List all achievements.

get/v2/achievements

Request

Query parameters

pageSizeinteger

The number of items in the response.

campaignIdinteger[]

Filter results by one or more campaign IDs.

To include multiple IDs, repeat the parameter for each one, for example,?campaignId=123&campaignId=456. The response contains only achievements associated with the specified campaigns.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

titlestring

Filter by the display name of the achievement.

applicationIdinteger

Filter by the ID of an Application connected to the achievement.

Response

OK

hasMoreboolean

Example response

{
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "name": "Order50Discount",
      "title": "50% off on 50th purchase.",
      "description": "50% off for every 50th purchase in a year.",
      "target": 50,
      "period": "1Y",
      "recurrencePolicy": "no_recurrence",
      "activationPolicy": "fixed_schedule",
      "fixedStartDate": "2024-01-15T15:04:05+07:00",
      "endDate": "2024-01-15T15:04:05+07:00",
      "subscribedApplications": [
        132,
        97
      ],
      "userId": 1234,
      "createdBy": "John Doe",
      "periodEndOverride": {
        "month": 11,
        "dayOfMonth": 23,
        "hour": 23,
        "minute": 59,
        "second": 59
      },
      "status": "active",
      "sandbox": true,
      "timezone": "Europe/Berlin",
      "campaignId": 3,
      "referencedByCampaigns": [
        {
          "id": 1,
          "applicationId": 2
        }
      ]
    }
  ]
}

Changes