---
title: Handles the specified tracking request.
slug: cms-12/api/handles-the-specified-tracking-request
docTags: 
createdAt: 2026-08-28T13:16:06.833Z
---

{
  "id": "OtrCv4YXEps2v_fabxTUH",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "/api/v1.0/Track",
    "servers": [],
    "name": "Handles the specified tracking request.",
    "description": "",
    "contentType": "application/json-patch+json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        },
        {
          "kind": "optional",
          "name": "Epi-User-IP-Address",
          "type": "string",
          "description": "<p>Can be used to pass the visitor IP address to Tracking API, for example when tracking statistics in website .NET code.</p>"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "The tracking request.",
          "customType": "TrackEventRequest",
          "schema": [
            {
              "name": "user",
              "kind": "optional",
              "type": "object",
              "description": "",
              "modelRef": "#/components/schemas/UserDataRequest",
              "customType": "UserDataRequest",
              "schema": [
                {
                  "name": "name",
                  "kind": "optional",
                  "type": "string",
                  "nullable": true,
                  "description": "The username."
                },
                {
                  "name": "email",
                  "kind": "optional",
                  "type": "string",
                  "nullable": true,
                  "description": "The user's email."
                },
                {
                  "name": "info",
                  "kind": "optional",
                  "type": "map",
                  "nullable": true,
                  "description": "The user information.",
                  "example": "",
                  "customType": "map<string, string>",
                  "schema": []
                }
              ]
            },
            {
              "name": "payload",
              "kind": "optional",
              "type": "object",
              "nullable": true,
              "description": "Additional data related to this event.",
              "example": "",
              "schema": []
            },
            {
              "name": "remoteAddress",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "Override remote address for track event"
            },
            {
              "name": "trackId",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The track identifier. \r\nIt is unique within all track event with the same EnvironmentId and Scope"
            },
            {
              "name": "deviceId",
              "kind": "required",
              "type": "string",
              "description": "The device identifier."
            },
            {
              "name": "eventType",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The type of the tracking event."
            },
            {
              "name": "value",
              "kind": "required",
              "type": "string",
              "description": "The tracking data value."
            },
            {
              "name": "scope",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The page scope."
            },
            {
              "name": "pageUri",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The page URI where event occurs."
            },
            {
              "name": "pageTitle",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The page title."
            },
            {
              "name": "eventTime",
              "kind": "optional",
              "type": "string<date-time>",
              "nullable": true,
              "description": "The event timestamp.",
              "format": "date-time"
            },
            {
              "name": "sessionId",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "The session id that relate to this event."
            }
          ],
          "modelRef": "#/components/schemas/TrackEventRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Turnstile",
          "name": "Authorization",
          "kind": "optional",
          "type": "apiKey",
          "description": "<p>Authorization header with a value in the following format: epi-single KEY.</p>",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "202",
        "description": "Success",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "400",
        "description": "Bad Request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/ErrorDetail",
                "customType": "ErrorDetail",
                "schema": [
                  {
                    "name": "code",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "message",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "target",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "details",
                    "kind": "optional",
                    "type": "array",
                    "nullable": true,
                    "description": "",
                    "modelRef": "#/components/schemas/ErrorDetail",
                    "customType": "ErrorDetail[]",
                    "schema": [
                      {
                        "name": "",
                        "description": "",
                        "customType": "Circular-Reference"
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "500",
        "description": "Server Error",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/ErrorDetail",
                "customType": "ErrorDetail",
                "schema": [
                  {
                    "name": "code",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "message",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "target",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": ""
                  },
                  {
                    "name": "details",
                    "kind": "optional",
                    "type": "array",
                    "nullable": true,
                    "description": "",
                    "modelRef": "#/components/schemas/ErrorDetail",
                    "customType": "ErrorDetail[]",
                    "schema": [
                      {
                        "name": "",
                        "description": "",
                        "customType": "Circular-Reference"
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "rgaoL6V5DzFeC_rDMRUdm",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url /api/v1.0/Track \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json-patch+json' \\\n     --data '{\n     \"deviceId\": \"\",\n     \"value\": \"\"\n     }'"
        },
        {
          "id": "JaYdFxr6j5uObhzOp5YfO",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar raw = JSON.stringify({\n   \"deviceId\": \"\",\n   \"value\": \"\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"/api/v1.0/Track\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "UEhkfbws5r4vSudkmHw0x",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/v1.0/Track\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json-patch+json\"\nrequest.body = JSON.dump({\n   \"deviceId\": \"\",\n   \"value\": \"\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "h2Ro7RMPRG9kcs2XtAzqj",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/api/v1.0/Track\"\n\npayload = json.dumps({\n   \"deviceId\": \"\",\n   \"value\": \"\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json-patch+json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "rgaoL6V5DzFeC_rDMRUdm"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-202",
          "language": "202",
          "code": "// Success\n"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad Request\n{\n  \"error\": {\n    \"code\": \"\",\n    \"message\": \"\",\n    \"target\": \"\",\n    \"details\": [\n      {\n        \"\": \"\"\n      }\n    ]\n  }\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized\n"
        },
        {
          "id": "response-3-500",
          "language": "500",
          "code": "// Server Error\n{\n  \"error\": {\n    \"code\": \"\",\n    \"message\": \"\",\n    \"target\": \"\",\n    \"details\": [\n      {\n        \"\": \"\"\n      }\n    ]\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-202"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}