Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Campaigns

Get Campaign Summary

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 17 June 2025

This endpoint returns analytics data for campaigns that were created after 17 June 2025. Older campaigns return empty data.

get/v1/campaigns/{campaignId}/summary

Query parameters

start_datestring date
Example:2023-12-22T10:13:06.487Z

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

end_datestring date
Example:2023-12-22T10:13:06.487Z

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

Response

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

OR
OR
OR
OR

Example response

{
  "campaign": {
    "id": "camp_f7fBbQxUuTN7dI7tGOo5XMDA",
    "voucher": {
      "start_date": "2022-09-20T00:00:00.000Z",
      "expiration_date": "2022-09-30T00:00:00.000Z",
      "validity_timeframe": {
        "duration": "PT1H",
        "interval": "P2D"
      },
      "validity_hours": {
        "daily": [
          {
            "start_time": "12:00",
            "expiration_time": "14:00"
          }
        ]
      }
    },
    "validity_timeframe": {
      "duration": "PT1H",
      "interval": "P2D"
    },
    "validity_hours": {
      "daily": [
        {
          "start_time": "12:00",
          "expiration_time": "14:00"
        }
      ]
    },
    "start_date": "2022-09-20T00:00:00.000Z",
    "expiration_date": "2022-09-30T00:00:00.000Z",
    "created_at": "2021-12-01T08:00:50.038Z",
    "updated_at": "2022-09-20T09:18:19.623Z",
    "category_id": "cat_0b688929a2476386a7",
    "categories": [
      {
        "created_at": "2022-07-14T10:45:13.156Z",
        "updated_at": "2022-08-16T10:52:08.094Z"
      }
    ],
    "referral_program": {
      "custom_event": {
        "id": "ms_Ll9enAm2BCN0M1s4VxWobLFM"
      },
      "referee_reward": {
        "related_object_parent": {
          "id": "camp_kdxp3vf1clQ9CFs1jpqv3tZe"
        }
      }
    },
    "access_settings_assignments": {
      "data": [
        {
          "id": "arsca_0ef5ee192117ae2416",
          "area_id": "ar_0ea6cd7b781b8f857f",
          "area_store_id": "ars_0ec347e2016bed85f4",
          "created_at": "2024-06-25T19:04:16.260Z"
        }
      ]
    }
  }
}