Jump to

• Request
• Response

Campaign Generation Confirmations

post

/{env}/v1/sites/{site-id}/generation-confirmations

If your site is configured to use *Generations with Confirmations* you should use the *Generation Confirmations* endpoint to tell Maxymiser that the generation was actually used. Unconfirmed generations won't appear in campaign results and tracked actions won't be attributed to them.

Request

Supported Media Types

• application/json

Path Parameters

• site-id: string
  Unique site identifier. The site id can be retrieved from the REST API.

Body ()

Generation Confirmation

Root Schema : generation

Type: object

Title: generation

Show Source

• campaigns: array campaigns
  Campaigns that a visitor has generated into.
• ipAddress(optional): string
  (Optional) IP address of the visitor. If omitted, "Source address" field of the packet sender is used to detect the client's IP. Used to pass Sandbox generation confirmations, in case the client's IP is listed in the Company IPs list.
• visitorState: string
  State of the current visitor as provided in responses of previous requests.

{
    "required":[
        "site-id",
        "campaigns",
        "visitorState"
    ],
    "title":"generation",
    "type":"object",
    "properties":{
        "campaigns":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/campaign"
            },
            "description":"Campaigns that a visitor has generated into."
        },
        "ipAddress":{
            "type":"string",
            "description":"(Optional) IP address of the visitor. If omitted, \"Source address\" field of the packet sender is used to detect the client's IP. Used to pass Sandbox generation confirmations, in case the client's IP is listed in the Company IPs list."
        },
        "visitorState":{
            "type":"string",
            "description":"State of the current visitor as provided in responses of previous requests."
        }
    },
    "example":{
        "campaigns":[
            {
                "name":"Serverside2"
            }
        ],
        "visitorState":"1215913303|AwAAAApVAgB/uLhOWw8AAREAAUL9qjQ...JggEAAUdFAQAABRQ=="
    }
}

Example:

{
    "campaigns":[
        {
            "name":"Serverside2"
        }
    ],
    "visitorState":"1215913303|AwAAAApVAgB/uLhOWw8AAREAAUL9qjQ...JggEAAUdFAQAABRQ=="
}

Nested Schema : campaigns

Type: array

Campaigns that a visitor has generated into.

Show Source

• Array of: object campaign

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/campaign"
    },
    "description":"Campaigns that a visitor has generated into."
}

Nested Schema : campaign

Type: object

Show Source

• campaign.name: string
  Name of the campaign. Note that only Live campaigns are valid.

{
    "type":"object",
    "required":[
        "campaign.name"
    ],
    "properties":{
        "campaign.name":{
            "type":"string",
            "description":"Name of the campaign. Note that only Live campaigns are valid."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Generated experience

Body ()

Root Schema : experiences

Type: object

Title: experiences

Show Source

• campaigns.name(optional): string
  Name of the campaign for which the generation was confirmed.
• campaigns.status(optional): string
  Status indicating whether the campaign generation confirmation was successful. Possible values include - *success*, *error*
• visitorState(optional): string
  Updated state of the current visitor that should be used in the subsequent request.

{
    "title":"experiences",
    "type":"object",
    "properties":{
        "campaigns.name":{
            "description":"Name of the campaign for which the generation was confirmed.",
            "type":"string"
        },
        "campaigns.status":{
            "description":"Status indicating whether the campaign generation confirmation was successful. Possible values include - *success*, *error*",
            "type":"string"
        },
        "visitorState":{
            "description":"Updated state of the current visitor that should be used in the subsequent request.",
            "type":"string"
        }
    },
    "example":{
        "campaigns":[
            {
                "name":"Serverside2",
                "status":"success"
            }
        ],
        "visitorState":"205117076|AgAAAApVAgB/uLhOWw8AAREAAUL...BAAAAAAAAAAABRQ=="
    }
}

Example:

{
    "campaigns":[
        {
            "name":"Serverside2",
            "status":"success"
        }
    ],
    "visitorState":"205117076|AgAAAApVAgB/uLhOWw8AAREAAUL...BAAAAAAAAAAABRQ=="
}

Back to Top