--- title: Track consumed events slug: api-documentation/track-consumed-events docTags: createdAt: 2026-08-27T16:57:40.129Z --- { "id": "Jpve1vTJu3YOyZjx6iO-Q", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/order/pubsub-events/consumed", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/pubsub-events/consumed" } ], "name": "Track consumed events", "description": "

This endpoint retrieves a track for all the events consumed from Google PubSub for a tenant.

\n

Authorized permissions:

\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": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "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-Consumed events found and returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "ConsumedEventTrackResponse[]", "schema": [ { "name": "tenant", "kind": "required", "type": "string", "description": "" }, { "name": "orderId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "orderEventId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "eventType", "kind": "required", "type": "string", "description": "" }, { "name": "publishedAt", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "retryCount", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "messageId", "kind": "required", "type": "string", "description": "" }, { "name": "systemLatency", "kind": "required", "type": "number", "description": "", "format": "double" }, { "name": "pubSubLatency", "kind": "required", "type": "number", "description": "", "format": "double" } ], "modelRef": "#/components/schemas/ConsumedEventTrackResponse", "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": "", "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 } ] }, { "statusCode": "403", "description": "The provided credentials were not valid for this endpoint. It may be that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "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 } ] }, { "statusCode": "500", "description": "Internal server error.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "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": "vwXOSVQex6SQLRmdg0mpj", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/order/pubsub-events/consumed \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "-e_fmN0IRw6yRPiQEMNg7", "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/order/pubsub-events/consumed\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "RmiX6iI3WSALS9aZmvt-2", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/pubsub-events/consumed\")\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": "ffhcBFNATcWPXUQ7u4U1d", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/pubsub-events/consumed\"\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": "vwXOSVQex6SQLRmdg0mpj" }, "results": { "languages": [ { "id": "Qxxy5IpdY3WvrYlSDaFZi", "language": "200", "code": "// Success-Consumed events found and returned.\n[\n {\n \"tenant\": \"\",\n \"orderId\": \"\",\n \"orderEventId\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"eventType\": \"\",\n \"publishedAt\": \"\",\n \"retryCount\": \"\",\n \"messageId\": \"\",\n \"systemLatency\": \"\",\n \"pubSubLatency\": \"\"\n }\n]" }, { "id": "Gqyh36bO8xHNKZykHxXqy", "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}" }, { "id": "KMYYMdMac9SBFvPvfil_u", "language": "403", "code": "// The provided credentials were not valid for this endpoint. It may be that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "KnrN7hMbyiUI2Pie8Ij1Q", "language": "500", "code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "Qxxy5IpdY3WvrYlSDaFZi" } }, "children": [ { "text": "" } ] }