Get Customer Achievement History

List customer's achievement history

GET/v1/customer_profiles/{integrationId}/achievements/{achievementId}

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Customer Achievement History action (under integration).
Fill in the fields below, then reference the result from later steps as {{getCustomerAchievementHistory.response.data}}.

Request

Path parameters

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.

achievementIdinteger (int64)required

The achievement identifier.

Query parameters

progressStatusarray<string>

Filter by customer progress status in the achievement.

startDatestring (date-time)

Timestamp that filters the results to only contain achievements created on or after the start date.

endDatestring (date-time)

Timestamp that filters the results to only contain achievements created before or on the end date.

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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

Response

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

totalResultSizeinteger (int64)

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.

json

{
  "totalResultSize": 1,
  "data": [
    {
      "endDate": {},
      "progress": 10,
      "completionDate": {},
      "startDate": {},
      "status": "completed"
    }
  ]
}

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

Was this page helpful?