{ "info": { "_postman_id": "eb238508-5404-488b-9811-3d02dd49461e", "name": "Coveo Activity Activities Dimensions API - Version 15 API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-eb238508-5404-488b-9811-3d02dd49461e" }, "item": [ { "name": "v15", "item": [ { "name": "dimensions", "item": [ { "name": "custom", "item": [ { "name": "{apiName}", "item": [ { "name": "Get a Custom Dimension", "id": "575f9a93-b882-401b-b76b-003dfe3c878c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "a3c7ad96-eef9-4020-855a-4d7020f669fd", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] } }, "response": [ { "id": "bc3f8047-a08c-4add-af75-6d9f8b3655d3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "apiName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"UPDATING\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-bc3f8047-a08c-4add-af75-6d9f8b3655d3" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-575f9a93-b882-401b-b76b-003dfe3c878c" }, { "name": "Create or Edit a Custom Dimension", "id": "c595f93b-0cc5-42e6-ac45-7f0c4db71d56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"type\": \"SHORT\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ], "variable": [ { "id": "48e6d29e-4f3d-404a-859b-412676c7c7f1", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] } }, "response": [ { "id": "fa62d5f2-655a-4a09-8f32-ae4842252dbd", "name": "The custom dimension has been edited", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"type\": \"SHORT\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ], "variable": [ { "key": "apiName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"UPDATING\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-fa62d5f2-655a-4a09-8f32-ae4842252dbd" }, { "id": "2754e59d-8698-4e0a-a75e-0a17cb34e793", "name": "The custom dimension has been created", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"type\": \"SHORT\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ], "variable": [ { "key": "apiName" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"UPDATING\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-2754e59d-8698-4e0a-a75e-0a17cb34e793" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-c595f93b-0cc5-42e6-ac45-7f0c4db71d56" }, { "name": "Delete a Custom Dimension", "id": "5e0adae6-0f78-4e07-b236-18f76b6523b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "9dc4e630-5e01-460b-9a1e-e295c1ec3d6b", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] } }, "response": [ { "id": "5f440bda-4276-43b7-acc5-148751ee1b0a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "apiName" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-5f440bda-4276-43b7-acc5-148751ee1b0a" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-5e0adae6-0f78-4e07-b236-18f76b6523b0" } ], "id": "95b9565a-468e-4560-8424-cbb8fe90f8ca", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-95b9565a-468e-4560-8424-cbb8fe90f8ca" }, { "name": "{event}", "item": [ { "name": "suggestions", "item": [ { "name": "Get a List of Dimensions That Have Data but Are Not Created Yet", "id": "26bdd363-6ddc-4c3a-b7f0-d55cf3245916", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:event/suggestions?org=&from=&to=&includeValueSamples=true&depth=1000", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":event", "suggestions" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Whether value samples should be included in the response.", "key": "includeValueSamples", "value": "true" }, { "description": "The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.", "key": "depth", "value": "1000" } ], "variable": [ { "id": "58f3d143-28bc-4014-936b-41ca65c1206b", "key": "event", "value": "custom_events", "description": "(Required) The type of event for which to look for suggestions." } ] } }, "response": [ { "id": "b572c8aa-2822-4ae5-bf9c-eefc9b4fe440", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:event/suggestions?org=&from=&to=&includeValueSamples=true&depth=1000", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":event", "suggestions" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Whether value samples should be included in the response.", "key": "includeValueSamples", "value": "true" }, { "description": "The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.", "key": "depth", "value": "1000" } ], "variable": [ { "key": "event" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"suggestions\": [\n {\n \"eventName\": \"\",\n \"apiName\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"eventName\": \"\",\n \"apiName\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-b572c8aa-2822-4ae5-bf9c-eefc9b4fe440" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-26bdd363-6ddc-4c3a-b7f0-d55cf3245916" } ], "id": "bf69e4d3-5a45-4a05-ab7f-12e15971e5cb", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-bf69e4d3-5a45-4a05-ab7f-12e15971e5cb" } ], "id": "d6a1dd40-d454-4425-933f-993fd069de8b", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-d6a1dd40-d454-4425-933f-993fd069de8b" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Custom Dimensions Service", "id": "43110176-6931-4193-90e6-ab552e44a0bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", "monitoring", "health" ] } }, "response": [ { "id": "105e1a67-c19e-4673-be5b-9c2cce4e0919", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-105e1a67-c19e-4673-be5b-9c2cce4e0919" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-43110176-6931-4193-90e6-ab552e44a0bf" } ], "id": "e9a62969-cd1a-4ca8-8501-53c751115dfd", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-e9a62969-cd1a-4ca8-8501-53c751115dfd" } ], "id": "2ec6be72-b7da-43be-af3c-48dcfe716cc4", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-2ec6be72-b7da-43be-af3c-48dcfe716cc4" }, { "name": "status", "item": [ { "name": "Get the Custom Dimensions Service Status", "id": "b98d50fe-146b-4e13-9438-cb3c732bbd96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", "status" ] } }, "response": [ { "id": "02f5372e-5161-4aea-944c-8e638da9e714", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-02f5372e-5161-4aea-944c-8e638da9e714" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-b98d50fe-146b-4e13-9438-cb3c732bbd96" } ], "id": "1d1937ec-b736-45ef-a7f5-775cf96b551c", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-1d1937ec-b736-45ef-a7f5-775cf96b551c" }, { "name": "{dimension}", "item": [ { "name": "values", "item": [ { "name": "Get the Values for a Custom Dimension", "id": "33cc71a7-264f-4006-b0c3-937bdfefd610", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:dimension/values?from=&to=&tz=Z&org=&f=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":dimension", "values" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of results to include in a page.", "key": "n", "value": "" } ], "variable": [ { "id": "fbce0b87-3a74-4dce-b901-9605ca95be6e", "key": "dimension", "value": "", "description": "(Required) The dimensions to fetch." } ] } }, "response": [ { "id": "f42f8bf8-42e8-4472-9305-74799e3d7995", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom/:dimension/values?from=&to=&tz=Z&org=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom", ":dimension", "values" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of results to include in a page.", "key": "n", "value": "" } ], "variable": [ { "key": "dimension" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"values\": [\n {\n \"Lorem__f\": {},\n \"aute1_\": {}\n },\n {\n \"pariatur__1\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-f42f8bf8-42e8-4472-9305-74799e3d7995" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-33cc71a7-264f-4006-b0c3-937bdfefd610" } ], "id": "30becf50-0039-4e50-9901-5c839d28d290", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-30becf50-0039-4e50-9901-5c839d28d290" } ], "id": "58150ed1-5be3-4512-b646-78fac4599c01", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-58150ed1-5be3-4512-b646-78fac4599c01" }, { "name": "Get All the Custom Dimensions", "id": "fcf17d5e-e4f3-4645-9deb-8b7ee9517a5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom?includeOnlyParents=false&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom" ], "query": [ { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "ca5c0d82-e080-4eaf-8ebe-3ecec86e8191", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/custom?includeOnlyParents=false&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom" ], "query": [ { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"DATE\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n },\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-ca5c0d82-e080-4eaf-8ebe-3ecec86e8191" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-fcf17d5e-e4f3-4645-9deb-8b7ee9517a5f" }, { "name": "Create a Custom Dimension", "id": "199198ea-3d98-4dcb-84bb-2a0e661daf49", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"type\": \"SHORT\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/dimensions/custom?org=&name=&event=clicks&event=custom_events&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically.", "key": "name", "value": "" }, { "description": "(Required) The types of event where this dimension will be added.", "key": "event", "value": "clicks" }, { "description": "(Required) The types of event where this dimension will be added.", "key": "event", "value": "custom_events" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ] } }, "response": [ { "id": "a71ea60e-9e36-4495-ba7f-6e57a8011d88", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"type\": \"SHORT\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/dimensions/custom?org=&name=&event=custom_events&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "custom" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically.", "key": "name", "value": "" }, { "description": "(Required) The types of event where this dimension will be added.", "key": "event", "value": "custom_events" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"UPDATING\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-a71ea60e-9e36-4495-ba7f-6e57a8011d88" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-199198ea-3d98-4dcb-84bb-2a0e661daf49" } ], "id": "a14c5ff6-a043-47b3-9cf7-51ab58be6223", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-a14c5ff6-a043-47b3-9cf7-51ab58be6223" }, { "name": "{apiName}", "item": [ { "name": "Get a Dimension", "id": "30675025-afd3-4442-b230-36d854041534", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "17cbbbe2-624f-43bb-af05-84e37f6f2899", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] } }, "response": [ { "id": "7b21ceee-2eac-4f02-bc10-0842fdd9a463", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "apiName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"UPDATING\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-7b21ceee-2eac-4f02-bc10-0842fdd9a463" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-30675025-afd3-4442-b230-36d854041534" } ], "id": "9b3aa497-3ff2-44c4-a903-55b713b2f1b3", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-9b3aa497-3ff2-44c4-a903-55b713b2f1b3" }, { "name": "exportables", "item": [ { "name": "Get All the Exportable Dimensions", "id": "e0dadc86-7cf3-4cfe-bed2-20c7ec670566", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/exportables?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "exportables" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "Whether to include custom dimensions within the results.", "key": "includeCustom", "value": "true" } ] } }, "response": [ { "id": "f59bcf6a-8953-4969-bb03-6b40231f700a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/exportables?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "exportables" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "Whether to include custom dimensions within the results.", "key": "includeCustom", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"DATE\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n },\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-f59bcf6a-8953-4969-bb03-6b40231f700a" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-e0dadc86-7cf3-4cfe-bed2-20c7ec670566" } ], "id": "836264d9-0e3f-45ad-b9a8-1b9f63217ecf", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-836264d9-0e3f-45ad-b9a8-1b9f63217ecf" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Dimensions Service", "id": "f6256b31-3e5c-4c31-a285-d8b2b1fedc00", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "monitoring", "health" ] } }, "response": [ { "id": "9c38879f-f68a-4e4f-b348-74533ad9c5c2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-9c38879f-f68a-4e4f-b348-74533ad9c5c2" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-f6256b31-3e5c-4c31-a285-d8b2b1fedc00" } ], "id": "9d39fd10-cd94-4f0c-a9bd-a77193e9a8e0", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-9d39fd10-cd94-4f0c-a9bd-a77193e9a8e0" } ], "id": "721c7fa2-01a0-4914-a9b2-6781b542e60e", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-721c7fa2-01a0-4914-a9b2-6781b542e60e" }, { "name": "status", "item": [ { "name": "Get the Dimensions Service Status", "id": "ceaf8d12-0fb4-4963-9aad-0ad74cb1443f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "status" ] } }, "response": [ { "id": "04f98a61-8760-4ec0-a857-2ba3cb3fe6a8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-04f98a61-8760-4ec0-a857-2ba3cb3fe6a8" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-ceaf8d12-0fb4-4963-9aad-0ad74cb1443f" } ], "id": "a9b06cbb-3098-4a5c-8878-315024f31cb5", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-a9b06cbb-3098-4a5c-8878-315024f31cb5" }, { "name": "{dimension}", "item": [ { "name": "values", "item": [ { "name": "Get the Values for a Dimension", "id": "3adc392f-402d-459e-a0ef-5c4fe7e7944f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/:dimension/values?from=&to=&tz=Z&org=&f=&f=&p=&n=&cached=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", ":dimension", "values" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of results to include in a page.", "key": "n", "value": "" }, { "description": "cached", "key": "cached", "value": "" } ], "variable": [ { "id": "887780c7-6df1-4aa8-87b2-3d97ec82311e", "key": "dimension", "value": "", "description": "(Required) The dimensions to fetch." } ] } }, "response": [ { "id": "a2de8cee-5d7c-46b8-9cd9-e7f99e4fa9f2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions/:dimension/values?from=&to=&tz=Z&org=&f=&p=&n=&cached=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions", ":dimension", "values" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of results to include in a page.", "key": "n", "value": "" }, { "description": "cached", "key": "cached", "value": "" } ], "variable": [ { "key": "dimension" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"values\": [\n {\n \"Lorem__f\": {},\n \"aute1_\": {}\n },\n {\n \"pariatur__1\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-a2de8cee-5d7c-46b8-9cd9-e7f99e4fa9f2" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-3adc392f-402d-459e-a0ef-5c4fe7e7944f" } ], "id": "95ac96e7-1692-4d69-8a1d-480507568566", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-95ac96e7-1692-4d69-8a1d-480507568566" } ], "id": "ea30a646-96e0-45f5-a894-20ffe44c08e1", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-ea30a646-96e0-45f5-a894-20ffe44c08e1" }, { "name": "Get All the Dimensions", "id": "6f216dac-fb8e-4352-8234-6308920e7c60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "Whether to include custom dimensions within the results.", "key": "includeCustom", "value": "true" } ] } }, "response": [ { "id": "146bf5c3-b8d5-433f-aced-734b31a396a7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/dimensions?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "dimensions" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output", "key": "includeOnlyParents", "value": "false" }, { "description": "Whether to include custom dimensions within the results.", "key": "includeCustom", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"DATE\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n },\n {\n \"apiNames\": [\n \"\",\n \"\"\n ],\n \"custom\": \"\",\n \"displayName\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"returnName\": \"\",\n \"status\": \"AVAILABLE\",\n \"type\": \"SHORT\",\n \"availableInVisit\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-146bf5c3-b8d5-433f-aced-734b31a396a7" } ], "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-6f216dac-fb8e-4352-8234-6308920e7c60" } ], "id": "62cf7031-b29c-4f9b-a81b-ab01b1617372", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-62cf7031-b29c-4f9b-a81b-ab01b1617372" } ], "id": "692a0bf0-0d08-4804-8808-c58ce8d40c9e", "createdAt": "2026-07-28T01:27:44.000Z", "updatedAt": "2026-07-28T01:27:44.000Z", "uid": "35240-692a0bf0-0d08-4804-8808-c58ce8d40c9e" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }