---
title: Upload events
slug: data-platform/api/upload-events
docTags:
createdAt: 2026-09-02T14:41:00.110Z
---
{
"id": "A2eMC6-A6iE2iJFvq2QnG",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.us1.odp.optimizely.com/v3/events",
"servers": [
{
"url": "https://api.us1.odp.optimizely.com/v3/events",
"description": "United States"
},
{
"url": "https://api.eu1.odp.optimizely.com/v3/events",
"description": "Europe"
},
{
"url": "https://api.au1.odp.optimizely.com/v3/events",
"description": "Asia-Pacific"
}
],
"name": "Upload events",
"description": "Upload customer actions (events) to Optimizely Data Platform (ODP).
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "array",
"description": "",
"customType": "Event[]",
"schema": [
{
"name": "type",
"kind": "required",
"type": "string",
"description": "the event type (for example, product)
",
"example": "product"
},
{
"name": "action",
"kind": "required",
"type": "string",
"description": "the event action associated with the type (for example, add_to_cart)
",
"example": "add_to_cart"
},
{
"name": "identifiers",
"kind": "required",
"type": "map",
"description": "any known identifiers associated with the customer that performed the event",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "data",
"kind": "optional",
"type": "map",
"description": "any additional fields you want to include on the event (for example, product_id)
",
"example": "",
"customType": "map",
"schema": []
}
],
"modelRef": "#/components/schemas/Event",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "x-api-key",
"name": "x-api-key",
"kind": "optional",
"type": "apiKey",
"in": "header"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "202",
"description": "Accepted",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "GenericUpdateResponse",
"schema": [
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "status",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "timestamp",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/GenericUpdateResponse",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "undefined",
"example": "{\"title\":\"Bad Request\",\"status\":400,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"invalids\":[{\"field\":\"delimiter\",\"reason\":\"Unrecognized delimiter, valid options are comma, tab or pipe\"}]}}",
"description": "",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "undefined",
"example": "{ \"message\": \"Forbidden\"}",
"description": "",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not Found",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "undefined",
"example": "{\"title\":\"Bad Request\",\"status\":404,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"message\":\"Not found description\"}}",
"description": "",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "9lp2ekB3SF7C86TKbRJab",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.us1.odp.optimizely.com/v3/events \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '[\n {\n \"type\": \"product\",\n \"action\": \"add_to_cart\",\n \"identifiers\": \"\"\n }\n ]'"
},
{
"id": "sAvZOcq2iJYCB5oERtTbA",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"type\": \"product\",\n \"action\": \"add_to_cart\",\n \"identifiers\": \"\"\n }\n]);\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.us1.odp.optimizely.com/v3/events\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "UQL125bmMB5L-UROXau2e",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.us1.odp.optimizely.com/v3/events\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"type\": \"product\",\n \"action\": \"add_to_cart\",\n \"identifiers\": \"\"\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "hU4xRIAOas5HG-nxPLH_2",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.us1.odp.optimizely.com/v3/events\"\n\npayload = json.dumps([\n {\n \"type\": \"product\",\n \"action\": \"add_to_cart\",\n \"identifiers\": \"\"\n }\n])\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "9lp2ekB3SF7C86TKbRJab"
},
"results": {
"languages": [
{
"id": "response-0-202",
"language": "202",
"code": "// Accepted\n{\n \"title\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Bad Request\n\"{\\\"title\\\":\\\"Bad Request\\\",\\\"status\\\":400,\\\"timestamp\\\":\\\"2018-09-10T21:07:10-05:00\\\",\\\"detail\\\":{\\\"invalids\\\":[{\\\"field\\\":\\\"delimiter\\\",\\\"reason\\\":\\\"Unrecognized delimiter, valid options are comma, tab or pipe\\\"}]}}\""
},
{
"id": "response-2-403",
"language": "403",
"code": "// Forbidden\n\"{ \\\"message\\\": \\\"Forbidden\\\"}\""
},
{
"id": "response-3-404",
"language": "404",
"code": "// Not Found\n\"{\\\"title\\\":\\\"Bad Request\\\",\\\"status\\\":404,\\\"timestamp\\\":\\\"2018-09-10T21:07:10-05:00\\\",\\\"detail\\\":{\\\"message\\\":\\\"Not found description\\\"}}\""
}
],
"selectedLanguageId": "response-0-202"
}
},
"children": [
{
"text": ""
}
]
}