Achievements

Export achievement customer data

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.

Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement.

The CSV file contains the following columns:

  • profileIntegrationID: The integration ID of the customer profile participating in the achievement.
  • title: The display name of the achievement in the Campaign Manager.
  • target: The required number of actions or the transactional milestone to complete the achievement.
  • progress: The current progress of the customer in the achievement.
  • status: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired'].
  • startDate: The date on which the customer profile started the achievement in RFC3339.
  • endDate: The date on which the achievement ends and resets for the customer profile in RFC3339.
  • completionDate: The date on which the customer profile completed the achievement in RFC3339.
get/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export

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.

achievementIdinteger required

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

Response

OK

Changes