Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
/
summary
Get Campaign Summary
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

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
campaignId
string
required

You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Query Parameters

​
start_date
string<date>

Timestamp representing the date which results must begin on. Represented in ISO 8601 format.

Example:

"2023-12-22T10:13:06.487Z"

​
end_date
string<date>

Timestamp representing the date which results must end on. Represented in ISO 8601 format.

Example:

"2023-12-22T10:13:06.487Z"

Response

Returns campaign analytics data. Returns different data depending on the campaign type.

  • Campaigns Summary - Discount Campaign details
  • Campaigns Summary - Promotion Campaign details
  • Campaigns Summary - Gift Campaign details
  • Campaigns Summary - Loyalty Campaign details
  • Campaigns Summary - Referral Campaign details

Response body schema for GET /v1/campaigns/{campaignId}/summary. Campaign summary data for discount campaigns. Contains the basic information about any type of campaign.

​
object
enum<string>
default:campaign_summary
required

The type of the object, which is campaign_summary.

Available options:
campaign_summary
​
campaign
object
required

This is an object representing a campaign.

​
redemptions
integer
required

Total number of redemptions, which includes successful and failed redemptions.

​
redemptions_succeeded
integer
required

Total number of successful redemptions.

​
redemptions_failed
integer
required

Total number of failed redemptions.

​
rollbacks
integer
required

Total number of rollbacks, which includes successful and failed rollbacks.

​
rollbacks_succeeded
integer
required

Total number of successful rollbacks.

​
rollbacks_failed
integer
required

Total number of failed rollbacks.

​
validations
integer
required

Total number of validations, which includes successful and failed validations.

​
validations_succeeded
integer
required

Total number of successful validations.

​
validations_failed
integer
required

Total number of failed validations.

​
orders_amount
integer
required

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.

​
orders_rolledback_amount
integer
required

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.

​
vouchers_created
integer
required

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.

​
vouchers_deleted
integer
required

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.

​
publications
integer
required

Total number of publications, which includes successful and failed publications.

​
publications_succeeded
integer
required

Total number of successful publications.

​
publications_failed
integer
required

Total number of failed publications.

​
discounted_amount
integer
required

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.

​
rolledback_discounted_amount
integer
required

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.

⌘I