Campaigns

Get all campaigns for the visitor

post

Get all campaigns value and metadata for a visitor ID and context

Body

application/json

anonymous_idstringOptional

trigger_hitbooleanOptional

visitor_consentbooleanOptional

visitor_idstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/campaigns

HTTPcURLJavaScriptPython

POST /v2/campaigns HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "anonymous_id": "text",
  "context": {
    "key_bool": true,
    "key_number": 1,
    "key_string": "text"
  },
  "trigger_hit": true,
  "visitor_consent": true,
  "visitor_id": "text"
}

{
  "campaigns": [
    {
      "id": "text",
      "variation": {
        "id": "text",
        "modifications": {
          "type": "text",
          "value": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "reference": true
      },
      "variationGroupId": "text"
    }
  ],
  "panic": true,
  "visitor_id": "text"
}

Get a single campaigns for the visitor

post

Get a single campaign value and metadata for a visitor ID and context

Path parameters

idstringRequired

Campaign ID

Body

application/json

anonymous_idstringOptional

trigger_hitbooleanOptional

visitor_consentbooleanOptional

visitor_idstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/campaigns/{id}

HTTPcURLJavaScriptPython

POST /v2/campaigns/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "anonymous_id": "text",
  "context": {
    "key_bool": true,
    "key_number": 1,
    "key_string": "text"
  },
  "trigger_hit": true,
  "visitor_consent": true,
  "visitor_id": "text"
}

{
  "id": "text",
  "variation": {
    "id": "text",
    "modifications": {
      "type": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "reference": true
  },
  "variationGroupId": "text"
}