younifyd
Menu

Get Customer Profile Achievement Progress

List customer achievements

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

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Customer Profile Achievement Progress action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getCustomerProfileAchievementProgress.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

integrationIdstringrequired

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 (int64)

The number of items in the response.

Default 50

skipinteger (int64)

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

achievementIdinteger (int64)

The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

titlestring

Filter results by the `title` of an achievement.

Response

Returns 200 with an object. Read it in later steps with {{getCustomerProfileAchievementProgress.response.data.<field>}}.

hasMoreboolean
dataarray<object>
statusstringrequired

The status of the achievement.

One ofinprogresscompletedexpirednot_started

progressnumberrequired

The current progress of the customer in the achievement.

startDatestring (date-time)

Timestamp at which the customer started the achievement.

completionDatestring (date-time)

Timestamp at which point the customer completed the achievement.

endDatestring (date-time)

Timestamp at which point the achievement ends and resets for the customer.

achievementIdinteger (int64)required

The internal ID of the achievement.

namestringrequired

The internal name of the achievement used in API requests.

titlestringrequired

The display name of the achievement in the Campaign Manager.

descriptionstring (string)required

The description of the achievement in the Campaign Manager.

campaignIdinteger (int64)required

The ID of the campaign the achievement belongs to.

targetnumber

The required number of actions or the transactional milestone to complete the achievement.

achievementRecurrencePolicystringrequired

The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.

One ofno_recurrenceon_expirationon_completion

achievementActivationPolicystringrequired

The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.

One ofuser_actionfixed_schedule

achievementFixedStartDatestring (date-time)

The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string.

achievementEndDatestring (date-time)

The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string.

achievementAllowRollbackAfterCompletionboolean

When `true`, customer progress can be rolled back in completed achievements.

json
{
  "hasMore": true,
  "data": [
    {
      "endDate": {},
      "achievementAllowRollbackAfterCompletion": false,
      "campaignId": 3,
      "achievementId": 3,
      "description": "50% off for every 50th purchase in a year.",
      "achievementFixedStartDate": {},
      "title": "50% off on 50th purchase.",
      "target": 10,
      "achievementRecurrencePolicy": "no_recurrence",
      "achievementActivationPolicy": "fixed_schedule",
      "name": "FreeCoffee10Orders",
      "achievementEndDate": {},
      "progress": 10,
      "completionDate": {},
      "startDate": {},
      "status": "completed"
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.