Authentication and authorization

MXO security framework uses OAuth 2.0 for authenticating access to data. For detailed information on how to create API credentials for a user and request an OAuth 2.0 token from MXO, see MXO API security.

Endpoints

The available endpoints and methods are:

Request structure

The table below provides an overview of the key parameters and attributes to include as part of the request.

JSON properties

The table below provides an overview of the key properties to include for each interaction as part of the batch processing request.

Response structure

For each request, the attributes listed below may be present in the response body.

Status codes

MXO can return the following status codes in a response.

Example use cases

The Batch Interaction API is primarily used for two key purposes:

1. Loading historical events at initial implementation to prime your workspace with data for analysis.

2. Uploading events from a system MXO is not listening to.

Example parameters

Example API call - Request

{
        "customerKey": "ABC123",
        "customerKeyName": "ck",
        "uri": "https://website.com/home",
        "timestamp": 1697647862144,
        "properties": [
            {
                "name": "email_key",
                "value": "email1@medallia.com"
            },
            {
                "name": "someNumber",
                "value": 123
            }
        ]
}
{
        "customerKey": "ABC124",
        "customerKeyName": "ck",
        "uri": "https://website.com/home",
        "timestamp": 1697647862143,
        "properties": [
            {
                "name": "email_key",
                "value": "email2@medallia.com"
            },
            {
                "name": "someNumber",
                "value": 124
            }
        ]
}

Example API call - Response

Expected response code

200 Batch processed successfully

Expected response body

{
    "rejectedCount": 0,
    "acceptedCount": 0,
    "totalCount": 2,
    "batchId": "3df46dbd-59f4-406c-8462-374df55cbaaf"
}

Possible error response code

400 Bad request or duplicate batch ID

Error response body

{
	"errorMessage": "Batch ID: test already exists",
	"batchId": "3df46dbd-59f4-406c-8462-374df55cbaaf"
}