TAtalon
Achievements

List customer 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.

For the given customer profile, list all the achievements that match your filter criteria.

get/v1/applications/{applicationId}/achievement_progress/{integrationId}

Request

Path parameters

applicationIdinteger required

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

integrationIdstring required

The integration identifier for this customer profile. Must be:

  • Unique within the deployment.
  • Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.

Once set, you cannot update this identifier.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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

achievementIdinteger

The ID of the achievement. You can get this ID with the List achievement endpoint.

titlestring

Filter results by the title of an achievement.

Response

OK

hasMoreboolean required

Example response

{
  "hasMore": true,
  "data": [
    {
      "status": "completed",
      "progress": 10,
      "startDate": "2024-01-01T15:04:05Z07:00",
      "completionDate": "2024-01-15T15:04:05Z07:00",
      "endDate": "2024-02-01T15:04:05Z07:00",
      "achievementId": 3,
      "name": "FreeCoffee10Orders",
      "title": "50% off on 50th purchase.",
      "description": "50% off for every 50th purchase in a year.",
      "campaignId": 3,
      "campaignIds": [
        1,
        14,
        27
      ],
      "referencedByCampaigns": [
        {
          "id": 1,
          "applicationId": 2
        }
      ],
      "target": 10,
      "achievementRecurrencePolicy": "no_recurrence",
      "achievementActivationPolicy": "fixed_schedule",
      "achievementFixedStartDate": "2024-01-15T15:04:05Z07:00",
      "achievementEndDate": "2024-02-15T15:04:05Z07:00"
    }
  ]
}

Changes

  • 7ef1b9504c3aRevision changes
    • breaking

      the response property /// became optional for the status

    • info

      response property data/items/allOf[subschema #2]/campaignId deprecated

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status