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

Path Parameters

campaignId
string
required
Example:

Query Parameters

start_date
string<date>
Example:
end_date
string<date>
Example:

Response

  • 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
object
enum<string>
default:campaign_summary
required
Available options:
campaign_summary
campaign
object
required
redemptions
integer
required
redemptions_succeeded
integer
required
redemptions_failed
integer
required
rollbacks
integer
required
rollbacks_succeeded
integer
required
rollbacks_failed
integer
required
validations
integer
required
validations_succeeded
integer
required
validations_failed
integer
required
orders_amount
integer
required
orders_rolledback_amount
integer
required
vouchers_created
integer
required
vouchers_deleted
integer
required
publications
integer
required
publications_succeeded
integer
required
publications_failed
integer
required
discounted_amount
integer
required
rolledback_discounted_amount
integer
required