get https://loyalty.yotpo.com/api/v2/campaigns
This endpoint returns a list of campaigns available for customers to participate in. If you provide a particular customer we can return their current status and eligibility on each of the campaigns.
Campaign Parameters Response
| Parameters | Type | Description |
|---|---|---|
id | int | Unique campaign id |
title | string | Campaign headline/One-liner |
details | string | Information on how to complete the campaign. |
type | string | One of the various campaign types, such as: SpendBasedCampaign, TransactionBasedCampaign, ReferralCampaign, TwitterRetweetCampaign, InstagramFollowCampaign, TwitterTweetCampaign, TwitterFollowCampaign, etc. |
cta_text | string | The text found on the button to participate in the campaign e.g. “Tweet”, “Follow”, etc. |
share_text | string | Message to be shared on social media, used in the TwitterTweetCampaign. |
url | string | Campaign dependent. Sometimes a destination to link to from call-to-action button, for TwitterTweet it’s a url to be included in the tweet. |
username | string | Campaign dependent. For TwitterFollowCampaign, it’s the Twitter handle to follow. |
entity_id | string | Campaign dependent. For TwitterRetweetCampaign, it’s the tweet id to retweet. |
icon | string | Image used for campaign. If it’s a URL, then it’s an image. Otherwise, it’s a Font Awesome class name. |
reward_text | string | Describes what the customer gets for completing (e.g. “500 Points”). |
created_at | datetime | Timestamp indicating when this campaign was created. |
updated_at | datetime | Timestamp reflecting the last update to this campaign. |
max_completions_per_user | int | The maximum number of times a single customer can complete this campaign. |
min_actions_required | int | The number of actions (for punch card style campaigns) that are required for the campaign to be completed. |
ends_at | datetime | Time stamp indicating the end date and time set for scheduled campaigns. |
Status Parameters Response
| Parameters | Type | Description |
|---|---|---|
global_completions_left | int | Number of times this campaign can be completed globally (for all customers in total). |
customer_actions_completed | int | Number of actions the customer has performed towards this campaign. |
customer_times_completed | int | Number of times the customer has already completed this campaign. |
customer_minutes_until_next_action | int | The number of minutes the customer must wait until they can complete take another action towards completing this campaign. |
customer_minutes_until_next_completion | int | Number of minutes the customer must wait until they are eligible to complete this campaign again. |