Campaigns

Our API allows you to retrieve targeted campaign data and collect analytics data for your campaigns.

Overview

These requests allow you to get campaign data based on targeting parameters and gain insights into your campaign performance with a single HTTPS request.

You can retrieve active campaigns through these APIs using set parameters (for example: language and campaign medium) in order to find matching campaigns for evaluation. Additionally, you can track campaign event data for analytics purposes and monitor how your campaigns are performing.

Get Campaign Data

You can retrieve campaign data of active campaigns based on the parameters provided using the v4/campaign/evaluate endpoint.

Evaluate Campaign Targeting

get

Evaluates active campaigns for given targeting parameters and returns campaign data, if there is a matching campaign.

Authorizations

HeaderToken

Query parameters

accountIdintegerOptional

campaignIdstring · min: 1 · max: 24Optional

languagestring · min: 1 · max: 5Optional

mediumstring · enum · min: 1Optional

• email - Email
• web - Web
• returns - Returns Portal

Possible values:

messagestring · min: 1 · max: 255Optional

orderNumberstring · min: 1Optional

previewbooleanOptional

statusstring · min: 1 · max: 255Optional

trackingIdstring · min: 1 · max: 24Optional

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v4/campaign/evaluate/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "campaignId": null,
  "trackingId": null,
  "customerSegmentationId": null,
  "audienceId": null,
  "openTrackingUrl": "text",
  "analyticsBaseUrl": "text",
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "placeholders": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "typedValues": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accountHasActiveCampaigns": null
}

Get Campaign Analytics

You can retrieve analytics data for campaign events using the v4/campaign/redirect endpoint.

Campaign Analytics Service

get

Collects campaign event data (clicks & opens) for analytics purposes and forwards the user to the redirect URL if provided.

Authorizations

HeaderToken

Query parameters

cstring · min: 1 · max: 24Optional

campaignIdstring · min: 1 · max: 24Optional

contentTypestring · min: 1 · max: 1024Optional

customerSegmentationIdstring · min: 1 · max: 24Optional

estring · min: 1 · max: 24Optional

emailIdstring · min: 1 · max: 24Optional

eventTypestring · enum · min: 1Required

• open - open
• click - click

Possible values:

mediumstring · enum · min: 1Optional

• email - Email
• web - Web
• returns - Returns Portal

Possible values:

redirectUrlstring · min: 1 · max: 1024Optional

sstring · min: 1 · max: 24Optional

trackingIdstring · min: 1 · max: 24Optional

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v4/campaign/redirect/?eventType=open HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "campaignId": null,
  "trackingId": null,
  "customerSegmentationId": null,
  "audienceId": null,
  "openTrackingUrl": "text",
  "analyticsBaseUrl": "text",
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "placeholders": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "typedValues": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accountHasActiveCampaigns": null
}