--- title: Get Events slug: api-documentation/get-events docTags: createdAt: 2026-08-27T17:08:30.775Z --- { "id": "uToi2859PnBCS4S6orb4k", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/siteactivity/events", "servers": [ { "url": "https://api.upstartcommerce.com/v1/siteactivity/events" } ], "name": "Get Events", "description": "

This endpoint returns information about the consumer's activity to be distributed inside the system.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "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" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [ { "kind": "optional", "name": "sessionId", "type": "string", "description": "

When included, this causes the response to return data based on the provided session id. When\nit is not included, the request will generate a new session id.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "AnonymousAuth", "name": "AnonymousAuth", "kind": "optional", "type": "http", "description": "This is the most basic authentication. The minimum requirement for access is a token representing the user as an anonymous client.", "scheme": "bearer" }, { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" }, { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success–events array returned with a session identifier for future calls.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "List of events for a given session id.", "customType": "OutClientEvents", "schema": [ { "name": "events", "kind": "required", "type": "array", "description": "

An event returned by the service, with its payload, originating service and the sites it applies to.

", "modelRef": "#/components/schemas/OutClientEvent", "customType": "OutClientEvent[]", "schema": [ { "name": "created", "kind": "required", "type": "string", "description": "

The date/time on which the event was generated.

", "example": "2017-07-21T17:32:28Z", "format": "date-time" }, { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for an event.", "format": "uuid" }, { "name": "name", "kind": "required", "type": "string", "description": "This identifies the type of event that was triggered." }, { "name": "payload", "kind": "required", "type": "object", "description": "

Depending on the type of event that was triggered, this will contain relevant information and data.

", "example": "", "schema": [] }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "service", "kind": "required", "type": "string", "description": "This identifies the service that generated the event." }, { "name": "traceId", "kind": "required", "type": "string", "description": "

For internal consumption by UpStart Commerce; to allow tracking of this event through various systems.

" } ] }, { "name": "sessionId", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/OutClientEvents", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload returned when a request fails validation, identifying the offending input by name, code and detail.

", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "-5noY4f4S77jMUYRvyHz-", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/siteactivity/events \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "zRGhJt7Mp-7raP0In7dWj", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/siteactivity/events\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "FRV2nOHEiO-Dg8A_0j6_e", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/siteactivity/events\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "83iYlfv-UEIDpH4sPiv_N", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/siteactivity/events\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "-5noY4f4S77jMUYRvyHz-" }, "results": { "languages": [ { "id": "3ZIicDo5NvTFltP0FzWEN", "language": "200", "code": "// Success–events array returned with a session identifier for future calls.\n{\n \"events\": [\n {\n \"created\": \"2017-07-21T17:32:28Z\",\n \"id\": \"\",\n \"name\": \"\",\n \"payload\": {},\n \"siteIds\": [\n \"\"\n ],\n \"service\": \"\",\n \"traceId\": \"\"\n }\n ],\n \"sessionId\": \"\"\n}" }, { "id": "jzOoc9tlBlFp2REWL69-_", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "D1qD84BSIyx2ldBOZ8dHL", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "3ZIicDo5NvTFltP0FzWEN" } }, "children": [ { "text": "" } ] }