Endpoints
- Campaign Object
- GETList Campaigns
- POSTCreate Campaign
- GETGet Campaign
- PUTUpdate Campaign
- DELDelete Campaign
- GETList Campaign Transactions
- POSTExport Campaign Transactions
- POSTAdd Vouchers to Campaign
- POSTAdd Voucher with Specific Code to Campaign
- POSTImport Vouchers to Campaign
- POSTImport Vouchers to Campaign by CSV
- POSTEnable Campaign
- POSTDisable Campaign
- GETGet Campaign Summary
- POSTExamine Campaign Qualificationdeprecated
curl --request GET \
--url https://{cluster}.voucherify.io/v1/campaigns/{campaignId}/summary \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "campaign_summary",
"campaign": {
"id": "camp_WaZ6r4LSF1alRaIwJVKS07bs",
"name": "Summer-2025",
"campaign_type": "DISCOUNT_COUPONS",
"type": "STANDALONE",
"voucher": {
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 2000,
"effect": "APPLY_TO_ORDER"
},
"redemption": {
"quantity": null
},
"is_referral_code": false
},
"auto_join": false,
"join_once": false,
"use_voucher_metadata_schema": true,
"vouchers_count": 1,
"active": true,
"metadata": {},
"created_at": "2025-06-17T08:05:57.720Z",
"creation_status": "DONE",
"vouchers_generation_status": "DONE",
"protected": false,
"category_id": null,
"categories": [],
"object": "campaign"
},
"redemptions": 10,
"redemptions_succeeded": 8,
"redemptions_failed": 2,
"rollbacks": 1,
"rollbacks_succeeded": 1,
"rollbacks_failed": 0,
"validations": 10,
"validations_succeeded": 8,
"validations_failed": 2,
"vouchers_created": 1,
"vouchers_deleted": 0,
"publications": 0,
"publications_succeeded": 0,
"publications_failed": 0,
"discounted_amount": 20000,
"rolledback_discounted_amount": 200,
"orders_amount": 19453,
"orders_rolledback_amount": 800
}Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type.
Use start_date and end_date to narrow down the data to specific periods.
🚧 Campaigns created before v20250602 version
This endpoint returns analytics data for campaigns that were created after the v20250602 version was released on 17 June 2025. Older campaigns return empty data.
curl --request GET \
--url https://{cluster}.voucherify.io/v1/campaigns/{campaignId}/summary \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "campaign_summary",
"campaign": {
"id": "camp_WaZ6r4LSF1alRaIwJVKS07bs",
"name": "Summer-2025",
"campaign_type": "DISCOUNT_COUPONS",
"type": "STANDALONE",
"voucher": {
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 2000,
"effect": "APPLY_TO_ORDER"
},
"redemption": {
"quantity": null
},
"is_referral_code": false
},
"auto_join": false,
"join_once": false,
"use_voucher_metadata_schema": true,
"vouchers_count": 1,
"active": true,
"metadata": {},
"created_at": "2025-06-17T08:05:57.720Z",
"creation_status": "DONE",
"vouchers_generation_status": "DONE",
"protected": false,
"category_id": null,
"categories": [],
"object": "campaign"
},
"redemptions": 10,
"redemptions_succeeded": 8,
"redemptions_failed": 2,
"rollbacks": 1,
"rollbacks_succeeded": 1,
"rollbacks_failed": 0,
"validations": 10,
"validations_succeeded": 8,
"validations_failed": 2,
"vouchers_created": 1,
"vouchers_deleted": 0,
"publications": 0,
"publications_succeeded": 0,
"publications_failed": 0,
"discounted_amount": 20000,
"rolledback_discounted_amount": 200,
"orders_amount": 19453,
"orders_rolledback_amount": 800
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
"camp_rRsfatlwN7unSeUIJDCYedal"
Query Parameters
Timestamp representing the date which results must begin on. Represented in ISO 8601 format.
"2023-12-22T10:13:06.487Z"
Timestamp representing the date which results must end on. Represented in ISO 8601 format.
"2023-12-22T10:13:06.487Z"
Response
Returns campaign analytics data. Returns different data depending on the campaign type.
- Campaigns Summary Get Response Body
- Campaigns Summary Get Response Body
- Campaigns Summary Get Response Body
- Campaigns Summary Get Response Body
- Campaigns Summary Get Response Body
Response body schema for GET /v1/campaigns/{campaignId}/summary.
Campaign summary data for discount campaigns.
Contains the basic information about any type of campaign.
The type of the object, which is campaign_summary.
campaign_summary This is an object representing a campaign.
Show child attributes
Show child attributes
Unique campaign ID, assigned by Voucherify.
"camp_f7fBbQxUuTN7dI7tGOo5XMDA"
Campaign name.
Type of campaign.
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, PROMOTION, REFERRAL_PROGRAM Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.
AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteriaSTATIC: vouchers need to be manually publishedSTANDALONE: campaign for single vouchers
AUTO_UPDATE, STATIC, STANDALONE Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
If this value is set to true, customers will be able to join the campaign only once. It is always false for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always true for loyalty campaigns and it cannot be changed in them.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.
"2021-12-01T08:00:50.038Z"
Indicates the status of the campaign creation.
DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING Indicates the status of the campaign's voucher generation.
DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING Indicates whether the resource can be deleted.
Unique category ID that this campaign belongs to.
"cat_0b688929a2476386a7"
Contains details about the campaign category. For the GET List campaigns endpoint, this is returned only if the expand=category query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET Campaign summary endpoint, it is always returned as an empty array.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
"2022-07-14T10:45:13.156Z"
Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
"2022-08-16T10:52:08.094Z"
The type of the object represented by JSON. This object stores information about the campaign.
An optional field to keep any extra textual information about the campaign such as a campaign description and details.
Schema model for a campaign voucher.
Show child attributes
Show child attributes
Type of voucher.
Contains information about the config used for the voucher code. Defines the code's pattern (prefix, postfix, length, charset, etc).
Show child attributes
Show child attributes
Number of characters in a generated code (excluding prefix and postfix).
Characters that can appear in the code.
Examples:
- Alphanumeric:
0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ - Alphabetic:
abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ - Alphabetic Lowercase:
abcdefghijklmnopqrstuvwxyz - Alphabetic Uppercase:
ABCDEFGHIJKLMNOPQRSTUVWXYZ - Numbers:
0123456789 - Custom: a custom character set
A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.
A text appended before the code.
A text appended after the code.
Internal value, does not change anything if provided.
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Defines the voucher discount type and details.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the voucher gift details.
Show child attributes
Show child attributes
Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. balance = amount - subtracted_amount - redemption.redeemed_amount.
Total amount of subtracted credits over the gift card lifetime.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Defines the voucher loyalty card details.
Show child attributes
Show child attributes
The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.
Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.
Show child attributes
Show child attributes
Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.
FIXED_DAY_OF_YEAR, MONTH Value of the period. Required for the period_type: MONTH.
Type of rounding of the expiration period. Optional for the period_type: MONTH.
END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH Value of rounding of the expiration period. Required for the rounding_type.
Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.
1 <= x <= 12Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.
1 <= x <= 31Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
"2022-09-20T00:00:00.000Z"
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
"2022-09-30T00:00:00.000Z"
Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.
"PT1H"
Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.
"P2D"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.
"PT1H"
Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.
"P2D"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
Total number of unique vouchers in campaign.
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
"2022-09-20T00:00:00.000Z"
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
"2022-09-30T00:00:00.000Z"
A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date and expiration_date.
trueindicates an active campaignfalseindicates an inactive campaign
The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.
"2022-09-20T09:18:19.623Z"
Unique category name.
Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the GET Campaign summary endpoint.
Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.
Show child attributes
Show child attributes
Define how a referral is triggered.
redemption, custom_event Defines the referee reward.
Show child attributes
Show child attributes
Details of the resource from which the reward originates.
Show child attributes
Show child attributes
Unique ID of the reward source.
"camp_kdxp3vf1clQ9CFs1jpqv3tZe"
Name of the reward source.
Type of resource represented by the source of the reward.
CAMPAIGN Type of reward.
LOYALTY_CARD, GIFT_VOUCHER Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
Defines the Loyalty Tiers Expiration.
Show child attributes
Show child attributes
Tier qualification.
BALANCE: Points balance is based on the customer's current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.
POINTS_IN_PERIOD: A customer qualifies for the tier only if the sum of the accumulated points in a defined time interval reaches the tier threshold.
BALANCE, POINTS_IN_PERIOD Defines the conditions for the start date of the tier.
Show child attributes
Show child attributes
What triggers the tier to be valid for a customer.
IMMEDIATE: After reaching the minimum required points.
NEXT_PERIOD: When the next qualification period starts.
IMMEDIATE, NEXT_PERIOD Defines the conditions for the expiration date of a tier.
Show child attributes
Show child attributes
What triggers the tier to expire for a customer.
END_OF_PERIOD: Expire tier at the end of the period.
END_OF_NEXT_PERIOD: Expire tier at the end of the next period.
BALANCE_DROP: Tier expires when the points balance drops below the required range of the tier.
CUSTOM: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier.
END_OF_PERIOD, END_OF_NEXT_PERIOD, BALANCE_DROP, CUSTOM Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of P3M will be valid for an additional duration of 3 months and a tier with a duration of P1D will be valid for an additional duration of 1 day.
Defines the rounding mechanism for tier expiration.
Show child attributes
Show child attributes
This mechanism describes a custom rounding for the expiration date.
MONTH, QUARTER, HALF_YEAR, YEAR, CUSTOM This mechanism describes a rounding strategy for the expiration date.
START, END Defines the type of unit of time in which the rounding period is counted.
MONTH Value for the unit of time that the rounding applies to. Units for this parameter are defined by the rounding.unit parameter.
0: January1: February2: March3: April4: May5: June6: July7: August8: September9: October10: November11: December
Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.
| Period | Definition |
|---|---|
| Calendar Month | Points collected in one calendar month January, February, March, etc. |
| Calendar Quarter | Points collected in the quarter - January - March - April - June - July - September - October - December |
| Calendar Half-year | Points collected in the half-year - January - June - July - December |
| Calendar Year | Points collected in one calendar year January - December |
MONTH, QUARTER, HALF_YEAR, YEAR Lists all assignments of the campaign to areas and stores. For GET List Campaigns, this is returned if the expand=access_settings_assignments query parameter is passed in the request. This object is not returned for the GET Campaign summary endpoint.
NOTE: This object is returned only if the Areas and Stores enterprise feature is enabled. Contact Voucherify Sales to learn more.
Show child attributes
Show child attributes
The type of the object represented by JSON. Default is list. This object stores information about campaign assignments to areas and stores
list Identifies the name of the attribute that contains the array of campaign assignments.
data Contains an array of campaign assignments.
Show child attributes
Show child attributes
Unique identifier of the campaign assignment.
"arsca_0ef5ee192117ae2416"
Unique identifier of the area to which the campaign is assigned.
"ar_0ea6cd7b781b8f857f"
Date and time when the assignment was made. The value is shown in the ISO 8601 format.
"2024-06-25T19:04:16.260Z"
The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores.
area_store_campaign_assignment Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the access_settings.assign.area_all_stores_ids in the request.
Unique identifier of the store to which the campaign is assigned.
"ars_0ec347e2016bed85f4"
Total number of areas and stores to which the campaign is assigned.
x >= 0Total number of redemptions, which includes successful and failed redemptions.
Total number of successful redemptions.
Total number of failed redemptions.
Total number of rollbacks, which includes successful and failed rollbacks.
Total number of successful rollbacks.
Total number of failed rollbacks.
Total number of validations, which includes successful and failed validations.
Total number of successful validations.
Total number of failed validations.
Total amount of orders related to the campaign. This amount is not reduced by orders_rolledback_amount. The value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 is represented as 1000.
Total amount of orders that were rolled back and are related to the campaign. The value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 is represented as 1000.
Total number of vouchers created within the campaign. Includes vouchers generated when the campaign was created, vouchers added manually, or vouchers generated automatically when a new customer joined the campaign.
Total number of vouchers deleted within the campaign. Includes vouchers moved to the bin and vouchers deleted permanently. Vouchers moved to the bin and then deleted permanently are counted once.
Total number of publications, which includes successful and failed publications.
Total number of successful publications.
Total number of failed publications.
Total amount of discounts related to the campaign. This amount is not reduced by the rolledback_discounted_amount. The value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 is represented as 1000.
Total amount of discounts orders that were rolled back and are related to the campaign. The value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 is represented as 1000.
Was this page helpful?