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 the achievements for a specific campaign.

get/v1/applications/{applicationId}/campaigns/{campaignId}/achievements

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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

titlestring

Filter by the display name for the achievement in the campaign manager.

Note: If no title is provided, all the achievements from the campaign are returned.

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",
      "periodEndOverride": {
        "month": 11,
        "dayOfMonth": 23,
        "hour": 23,
        "minute": 59,
        "second": 59
      },
      "recurrencePolicy": "no_recurrence",
      "activationPolicy": "fixed_schedule",
      "fixedStartDate": "2024-01-15T15:04:05Z07:00",
      "endDate": "2024-02-15T15:04:05Z07:00",
      "campaignId": 1,
      "userId": 1234,
      "createdBy": "John Doe",
      "status": "inprogress"
    }
  ]
}

Changes