{ "info": { "_postman_id": "9caaafb3-3bdf-46f0-b0c9-e61fae7cc68e", "name": "Coveo Activity Activities Dimensions API - Version 14 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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-9caaafb3-3bdf-46f0-b0c9-e61fae7cc68e" }, "item": [ { "name": "v14", "item": [ { "name": "dimensions", "item": [ { "name": "custom", "item": [ { "name": "{apiName}", "item": [ { "name": "Get a Custom Dimension", "id": "31e9ff86-40ee-412e-85c0-752185697e72", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "6671d478-c5fd-468a-b59f-3cf47a3b25b1", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "29c812ae-2b18-4f3b-a2cc-3bf6bcfa721a", "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}}/v14/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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\": \"AVAILABLE\",\n \"type\": \"TEXT\",\n \"availableInVisit\": \"\"\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-29c812ae-2b18-4f3b-a2cc-3bf6bcfa721a" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-31e9ff86-40ee-412e-85c0-752185697e72" }, { "name": "Create or Edit a Custom Dimension", "id": "9c040ea2-6153-4194-9284-7abf14b4e170", "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\": \"TEXT\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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": "0d9a8507-25c9-451d-9500-38ab8fb09554", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "51e0c95f-1690-44be-9b4f-2de9dee11a84", "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\": \"TEXT\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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\": \"AVAILABLE\",\n \"type\": \"TEXT\",\n \"availableInVisit\": \"\"\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-51e0c95f-1690-44be-9b4f-2de9dee11a84" }, { "id": "9619bdda-39c6-4be2-9402-c0d2d995f5e3", "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\": \"TEXT\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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\": \"AVAILABLE\",\n \"type\": \"TEXT\",\n \"availableInVisit\": \"\"\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-9619bdda-39c6-4be2-9402-c0d2d995f5e3" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-9c040ea2-6153-4194-9284-7abf14b4e170" }, { "name": "Get a Custom Dimension", "id": "c826be77-187e-45f5-a67d-7bc64c552b5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "custom", ":apiName" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "d5a69fe7-346e-4208-a251-bf283ac9efb7", "key": "apiName", "value": "", "description": "(Required) Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "3be515cc-d65c-4d5f-b006-111338b20918", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:apiName?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-3be515cc-d65c-4d5f-b006-111338b20918" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-c826be77-187e-45f5-a67d-7bc64c552b5c" } ], "id": "7973eb74-cc47-4df1-a9c9-090293eedcfa", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-7973eb74-cc47-4df1-a9c9-090293eedcfa" }, { "name": "{event}", "item": [ { "name": "suggestions", "item": [ { "name": "Get a List of Dimensions That Have Data but Are Not Created Yet", "id": "a7d8016c-84c6-4273-965c-43a97766d949", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:event/suggestions?org=&from=&to=&includeValueSamples=true&depth=1000", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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": "61c8f293-2d2f-45a2-b127-c083b71759e1", "key": "event", "value": "custom_events", "description": "(Required) The type of event for which to look for suggestions." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "0f5633b8-7be6-42e1-b63c-6bf9c436f202", "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}}/v14/dimensions/custom/:event/suggestions?org=&from=&to=&includeValueSamples=true&depth=1000", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-0f5633b8-7be6-42e1-b63c-6bf9c436f202" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-a7d8016c-84c6-4273-965c-43a97766d949" } ], "id": "525c3090-4938-4c19-96f8-1a4e101f1672", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-525c3090-4938-4c19-96f8-1a4e101f1672" } ], "id": "b08aefa2-b49e-4102-a191-d5dfbd9048d5", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-b08aefa2-b49e-4102-a191-d5dfbd9048d5" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Custom Dimensions Service", "id": "383009cc-c12c-4f4b-8956-63c206e31eed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "custom", "monitoring", "health" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "d8f042fc-3f20-468a-aa03-c5a6cbc312ab", "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}}/v14/dimensions/custom/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-d8f042fc-3f20-468a-aa03-c5a6cbc312ab" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-383009cc-c12c-4f4b-8956-63c206e31eed" } ], "id": "501a096a-92b2-46c0-87d0-ad464de007ee", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-501a096a-92b2-46c0-87d0-ad464de007ee" } ], "id": "80c8f070-bc0c-4dcb-9480-cb29a8400af2", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-80c8f070-bc0c-4dcb-9480-cb29a8400af2" }, { "name": "status", "item": [ { "name": "Get the Custom Dimensions Service Status", "id": "7dea495f-8e03-469b-b49d-10ce55c26e58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "custom", "status" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "40af5633-f8c0-488f-8bf7-0eaefb960bbc", "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}}/v14/dimensions/custom/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-40af5633-f8c0-488f-8bf7-0eaefb960bbc" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-7dea495f-8e03-469b-b49d-10ce55c26e58" } ], "id": "b8c126b3-e356-4e16-a736-8a409ac7ef70", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-b8c126b3-e356-4e16-a736-8a409ac7ef70" }, { "name": "{dimension}", "item": [ { "name": "values", "item": [ { "name": "Get the Values for a Custom Dimension", "id": "d33d9cb4-8598-4df9-8ef9-e12446521c0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom/:dimension/values?from=&to=&tz=Z&org=&f=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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 result to include in a page.", "key": "n", "value": "" } ], "variable": [ { "id": "a0858434-b076-4107-81b6-0b2d6e81809f", "key": "dimension", "value": "", "description": "(Required) The dimensions to fetch." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "3cd406af-52ab-4ee8-ae6e-f1d7a87553f3", "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}}/v14/dimensions/custom/:dimension/values?from=&to=&tz=Z&org=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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 result 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 \"pariatur_68\": {},\n \"adipisicing3\": {},\n \"incididunt_3c\": {},\n \"ex_2\": {}\n },\n {\n \"in_f5\": {},\n \"dolored\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-3cd406af-52ab-4ee8-ae6e-f1d7a87553f3" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-d33d9cb4-8598-4df9-8ef9-e12446521c0d" } ], "id": "f0e72345-213c-4d8b-950c-21e2ce91ebaa", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-f0e72345-213c-4d8b-950c-21e2ce91ebaa" } ], "id": "b1ee0226-9c34-43eb-8db5-6094bc9e8371", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-b1ee0226-9c34-43eb-8db5-6094bc9e8371" }, { "name": "Get All the Custom Dimensions", "id": "cf828487-faf5-44ed-b054-bafdf6778a45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/custom?includeOnlyParents=false&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "3b75bd42-c52e-455e-b5e1-08b284d0cfbc", "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}}/v14/dimensions/custom?includeOnlyParents=false&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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\": \"UPDATING\",\n \"type\": \"NUMBER\",\n \"availableInVisit\": \"\"\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 }\n]", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-3b75bd42-c52e-455e-b5e1-08b284d0cfbc" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-cf828487-faf5-44ed-b054-bafdf6778a45" }, { "name": "Create a Custom Dimension", "id": "5cecf2e2-1800-4ae8-87dc-43702986cadf", "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\": \"BOOLEAN\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/dimensions/custom?org=&name=&event=searches&event=searches&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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": "searches" }, { "description": "(Required) The types of event where this dimension will be added.", "key": "event", "value": "searches" }, { "description": "Whether to update the custom dimension in past events.", "key": "updatePastEvents", "value": "false" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "e5360275-4c36-4cad-84e5-1f7fc4c432e3", "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\": \"BOOLEAN\",\n \"path\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/dimensions/custom?org=&name=&event=searches&updatePastEvents=false", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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": "searches" }, { "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\": \"AVAILABLE\",\n \"type\": \"TEXT\",\n \"availableInVisit\": \"\"\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-e5360275-4c36-4cad-84e5-1f7fc4c432e3" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-5cecf2e2-1800-4ae8-87dc-43702986cadf" } ], "id": "f1b2be8d-cd6c-4a1c-bb42-ccd61761d45d", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-f1b2be8d-cd6c-4a1c-bb42-ccd61761d45d" }, { "name": "{apiName}", "item": [ { "name": "Get a Dimension", "id": "9fe1b22b-2658-4749-99c0-700dd51816f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/:apiName", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", ":apiName" ], "variable": [ { "id": "4c94831b-e735-4b60-ba92-7be7d4947c37", "key": "apiName" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "02e04428-7114-4937-90ae-97c6435e3178", "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}}/v14/dimensions/:apiName", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", ":apiName" ], "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\": \"AVAILABLE\",\n \"type\": \"TEXT\",\n \"availableInVisit\": \"\"\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-02e04428-7114-4937-90ae-97c6435e3178" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-9fe1b22b-2658-4749-99c0-700dd51816f1" } ], "id": "5720a6f8-0be8-400d-9b35-b153c0b48862", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-5720a6f8-0be8-400d-9b35-b153c0b48862" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Dimensions Service", "id": "6fb0d729-4ce6-4713-b3ce-35e8f84cdc64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "monitoring", "health" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "5995a184-4ba2-4976-8ed2-ac77835bf8a2", "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}}/v14/dimensions/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-5995a184-4ba2-4976-8ed2-ac77835bf8a2" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-6fb0d729-4ce6-4713-b3ce-35e8f84cdc64" } ], "id": "613ca78f-5a1b-45c0-a694-bc1ec7cd3183", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-613ca78f-5a1b-45c0-a694-bc1ec7cd3183" } ], "id": "09ee79aa-88d6-4167-8588-5e9f565c18a4", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-09ee79aa-88d6-4167-8588-5e9f565c18a4" }, { "name": "status", "item": [ { "name": "Get the Dimensions Service Status", "id": "49d703cc-792a-424d-a087-497eac282d51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", "status" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "d4f88441-e09e-475d-b1cc-e0eb9e9aface", "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}}/v14/dimensions/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-d4f88441-e09e-475d-b1cc-e0eb9e9aface" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-49d703cc-792a-424d-a087-497eac282d51" } ], "id": "25c7d442-45d8-4e02-bf3f-bdf71b0171b2", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-25c7d442-45d8-4e02-bf3f-bdf71b0171b2" }, { "name": "{dimension}", "item": [ { "name": "values", "item": [ { "name": "Get the Values for a Dimension", "id": "c001b761-50c8-4fce-89bb-46d375d55d4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions/:dimension/values?from=&to=&tz=Z&org=&f=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", ":dimension", "values" ], "query": [ { "description": "from", "key": "from", "value": "" }, { "description": "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 result to include in a page.", "key": "n", "value": "" } ], "variable": [ { "id": "f172afb8-d9a7-4773-9fd8-d53d61a5af5a", "key": "dimension", "value": "", "description": "(Required) The dimensions to fetch." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "f304e2d0-77c4-4b98-b39a-52f2ca358919", "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}}/v14/dimensions/:dimension/values?from=&to=&tz=Z&org=&f=&p=&n=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "dimensions", ":dimension", "values" ], "query": [ { "description": "from", "key": "from", "value": "" }, { "description": "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 result 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 \"pariatur_68\": {},\n \"adipisicing3\": {},\n \"incididunt_3c\": {},\n \"ex_2\": {}\n },\n {\n \"in_f5\": {},\n \"dolored\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-f304e2d0-77c4-4b98-b39a-52f2ca358919" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-c001b761-50c8-4fce-89bb-46d375d55d4b" } ], "id": "4ab622da-bdc1-4e4b-9480-05ce2077711c", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-4ab622da-bdc1-4e4b-9480-05ce2077711c" } ], "id": "1f7ca305-2517-499b-afca-ba2d4c800e56", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-1f7ca305-2517-499b-afca-ba2d4c800e56" }, { "name": "Get All the Dimensions", "id": "91c26e76-c6ce-431e-8d6e-0e3639376af3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/dimensions?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "a0f24046-dc25-4c6c-904f-74e4b094c0fe", "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}}/v14/dimensions?org=&includeOnlyParents=false&includeCustom=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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\": \"UPDATING\",\n \"type\": \"NUMBER\",\n \"availableInVisit\": \"\"\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 }\n]", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-a0f24046-dc25-4c6c-904f-74e4b094c0fe" } ], "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-91c26e76-c6ce-431e-8d6e-0e3639376af3" } ], "id": "2eff295b-4efd-4f3c-835e-13390e053395", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-2eff295b-4efd-4f3c-835e-13390e053395" } ], "id": "8fcaff63-ccb4-40d0-a997-727275264801", "createdAt": "2026-07-28T01:27:42.000Z", "updatedAt": "2026-07-28T01:27:42.000Z", "uid": "35240-8fcaff63-ccb4-40d0-a997-727275264801" } ], "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" } ] }