Jump to

• Request
• Response

Actions

post

/{env}/v1/sites/{site-id}/actions

The *Actions* endpoint tracks actions for the given visitor.

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 ()

Actions

Root Schema : actions

Type: object

Title: actions

Show Source

• actions: array actions
  Actions to be tracked for the visitor.
• 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 track Sandbox actions, in case the client's IP is listed in the Company IPs list.
• visitorIds(optional): object visitorIds
  (Optional) External visitor identifiers. Can be used for targeting, personalization, segmentation and reporting (via the Campaign Data Export). Pass as "id slot":"value" pairs.
• visitorState: string
  State of the current visitor as provided in responses of previous requests.

{
    "required":[
        "site-id",
        "actions",
        "visitorState"
    ],
    "title":"actions",
    "type":"object",
    "properties":{
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/action"
            },
            "description":"Actions to be tracked for the visitor."
        },
        "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 track Sandbox actions, in case the client's IP is listed in the Company IPs list."
        },
        "visitorIds":{
            "type":"object",
            "description":"(Optional) External visitor identifiers. Can be used for targeting, personalization, segmentation and reporting (via the Campaign Data Export). Pass as \"id slot\":\"value\" pairs."
        },
        "visitorState":{
            "type":"string",
            "description":"State of the current visitor as provided in responses of previous requests."
        }
    },
    "example":{
        "actions":[
            {
                "name":"ItemsInBasket",
                "value":"3",
                "attribute":"USD"
            },
            {
                "name":"OrderValue",
                "value":"$5.99"
            }
        ],
        "visitorIds":{
            "5":"24350056"
        },
        "visitorState":"-1338188648|AwAAAApVAgB/uLhOWw8AA...ntbDwD/////AVsPWw///wEAAAEA"
    }
}

Example:

{
    "actions":[
        {
            "name":"ItemsInBasket",
            "value":"3",
            "attribute":"USD"
        },
        {
            "name":"OrderValue",
            "value":"$5.99"
        }
    ],
    "visitorIds":{
        "5":"24350056"
    },
    "visitorState":"-1338188648|AwAAAApVAgB/uLhOWw8AA...ntbDwD/////AVsPWw///wEAAAEA"
}

Nested Schema : actions

Type: array

Actions to be tracked for the visitor.

Show Source

• Array of: object action

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/action"
    },
    "description":"Actions to be tracked for the visitor."
}

Nested Schema : visitorIds

Type: object

(Optional) External visitor identifiers. Can be used for targeting, personalization, segmentation and reporting (via the Campaign Data Export). Pass as "id slot":"value" pairs.

Nested Schema : action

Type: object

Show Source

• action.attribute(optional): string
  (Optional) Attribute of the action to be tracked. You can use this to track additional information about the action. E.g. currency for a monetary value.
• action.name: string
  Name of the action to be tracked. Note that an action should be present for the campaign in order to be tracked.
• action.value(optional): string
  (Optional) Value of the action to be tracked. You can use this to capture information about an action. E.g. monetary value for a purchase action.

{
    "type":"object",
    "required":[
        "action.name"
    ],
    "properties":{
        "action.name":{
            "type":"string",
            "description":"Name of the action to be tracked. Note that an action should be present for the campaign in order to be tracked."
        },
        "action.value":{
            "type":"string",
            "description":"(Optional) Value of the action to be tracked. You can use this to capture information about an action. E.g. monetary value for a purchase action."
        },
        "action.attribute":{
            "type":"string",
            "description":"(Optional) Attribute of the action to be tracked. You can use this to track additional information about the action. E.g. currency for a monetary value."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Tracked actions

Body ()

Root Schema : tracked actions

Type: object

Title: tracked actions

Show Source

• action.name(optional): string
  Name of the action.
• actions(optional): object actions
  Actions tracked for the visitor.
• actions.status(optional): string
  Either *success* or *error*.
• visitorState(optional): string
  Updated state of the current visitor that should be used in the subsequent request.

{
    "title":"tracked actions",
    "type":"object",
    "properties":{
        "actions":{
            "description":"Actions tracked for the visitor.",
            "type":"object"
        },
        "action.name":{
            "description":"Name of the action.",
            "type":"string"
        },
        "actions.status":{
            "description":"Either *success* or *error*.",
            "type":"string"
        },
        "visitorState":{
            "description":"Updated state of the current visitor that should be used in the subsequent request.",
            "type":"string"
        }
    },
    "example":{
        "actions":[
            {
                "name":"ItemsInBasket",
                "status":"success"
            },
            {
                "name":"OrderValue",
                "status":"error",
                "errors":[
                    {
                        "message":"Invalid action value: '$5.99'. Must be an integer",
                        "parameter":"value",
                        "code":"400"
                    }
                ]
            }
        ],
        "visitorState":"Y2FtcGFpZ25OYW1lOiBjYW1wYWlnbjE7IGV4cGVyaWVuY2VzOiBlbGVtZW50MTp2YXJpYW50MSwgZ2VuZXJhdGlvbmlkOjMyNDMyNDMyNDMy"
    }
}

Example:

{
    "actions":[
        {
            "name":"ItemsInBasket",
            "status":"success"
        },
        {
            "name":"OrderValue",
            "status":"error",
            "errors":[
                {
                    "message":"Invalid action value: '$5.99'. Must be an integer",
                    "parameter":"value",
                    "code":"400"
                }
            ]
        }
    ],
    "visitorState":"Y2FtcGFpZ25OYW1lOiBjYW1wYWlnbjE7IGV4cGVyaWVuY2VzOiBlbGVtZW50MTp2YXJpYW50MSwgZ2VuZXJhdGlvbmlkOjMyNDMyNDMyNDMy"
}

Nested Schema : actions

Type: object

Actions tracked for the visitor.

Back to Top