{ "info": { "_postman_id": "39e75b7f-5ad5-47eb-a66a-c2d80fa16c8d", "name": "Coveo Activity Activities Data Health 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:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-39e75b7f-5ad5-47eb-a66a-c2d80fa16c8d" }, "item": [ { "name": "v15", "item": [ { "name": "datahealth", "item": [ { "name": "events", "item": [ { "name": "payload", "item": [ { "name": "Get the Payload of an Event.", "id": "83642519-0ef3-4bf9-add3-6748aef259e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/events/payload?timestamp=&eventId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events", "payload" ], "query": [ { "description": "(Required) The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "timestamp", "value": "" }, { "description": "(Required) The id of the event for which to return information.", "key": "eventId", "value": "" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "552895f0-9eb5-4bb4-a242-0f23915a5afb", "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/datahealth/events/payload?timestamp=&eventId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events", "payload" ], "query": [ { "description": "(Required) The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "timestamp", "value": "" }, { "description": "(Required) The id of the event for which to return information.", "key": "eventId", "value": "" }, { "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 \"eventId\": \"\",\n \"timestamp\": \"\",\n \"eventPayload\": {}\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-552895f0-9eb5-4bb4-a242-0f23915a5afb" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-83642519-0ef3-4bf9-add3-6748aef259e5" } ], "id": "a4227b77-e7a9-48ba-98a4-fbd8feaec928", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-a4227b77-e7a9-48ba-98a4-fbd8feaec928" }, { "name": "problems", "item": [ { "name": "Get Problems About Events", "id": "276ac67e-a1b7-4748-9a98-f19d1a4c5985", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/events/problems?from=&to=&eventType=&eventType=&searchHub=&searchHub=&trackingId=&trackingId=&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events", "problems" ], "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": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "baa44dea-b38d-49c4-a8f6-ad13c8c86871", "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/datahealth/events/problems?from=&to=&eventType=&searchHub=&trackingId=&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events", "problems" ], "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": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "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 \"problems\": [\n {\n \"eventType\": \"\",\n \"trackingId\": \"\",\n \"searchHub\": \"\",\n \"failedEvents\": \"\",\n \"totalEvents\": \"\",\n \"validationErrors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n }\n ],\n \"sampleEvents\": [\n \"\",\n \"\"\n ],\n \"sampleEventsTimestamps\": [\n \"\",\n \"\"\n ]\n },\n {\n \"eventType\": \"\",\n \"trackingId\": \"\",\n \"searchHub\": \"\",\n \"failedEvents\": \"\",\n \"totalEvents\": \"\",\n \"validationErrors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n }\n ],\n \"sampleEvents\": [\n \"\",\n \"\"\n ],\n \"sampleEventsTimestamps\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-baa44dea-b38d-49c4-a8f6-ad13c8c86871" }, { "id": "cdb34b45-65a0-4715-8f7d-bc3fdb005fdc", "name": "PAGE_NOT_FOUND", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/events/problems?from=&to=&eventType=&searchHub=&trackingId=&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events", "problems" ], "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": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-cdb34b45-65a0-4715-8f7d-bc3fdb005fdc" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-276ac67e-a1b7-4748-9a98-f19d1a4c5985" } ], "id": "7ff7ca2a-5996-4d12-9f7f-151d6e1680df", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-7ff7ca2a-5996-4d12-9f7f-151d6e1680df" }, { "name": "Get Health Information About Events", "id": "82f6e64a-92dd-491f-8332-3f0226ec21c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/events?from=&to=&clientId=&clientId=&visitId=&visitId=&eventSource=&eventSource=&eventType=&eventType=&searchHub=&searchHub=&trackingId=&trackingId=&healthStatus=VALID&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events" ], "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": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "A health status for which the events will be returned.", "key": "healthStatus", "value": "VALID" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "05c3e176-a3d4-4c85-b04a-7e90756806fd", "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/datahealth/events?from=&to=&clientId=&visitId=&eventSource=&eventType=&searchHub=&trackingId=&healthStatus=VALID&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events" ], "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": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "A health status for which the events will be returned.", "key": "healthStatus", "value": "VALID" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "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 \"events\": [\n {\n \"clientId\": \"\",\n \"eventId\": \"\",\n \"searchHub\": \"\",\n \"source\": \"\",\n \"timestamp\": \"\",\n \"trackingId\": \"\",\n \"type\": \"\",\n \"visitId\": \"\",\n \"validationErrors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n }\n ]\n },\n {\n \"clientId\": \"\",\n \"eventId\": \"\",\n \"searchHub\": \"\",\n \"source\": \"\",\n \"timestamp\": \"\",\n \"trackingId\": \"\",\n \"type\": \"\",\n \"visitId\": \"\",\n \"validationErrors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"path\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-05c3e176-a3d4-4c85-b04a-7e90756806fd" }, { "id": "f824f8d8-34db-43b6-b77f-4232947df193", "name": "PAGE_NOT_FOUND", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/events?from=&to=&clientId=&visitId=&eventSource=&eventType=&searchHub=&trackingId=&healthStatus=VALID&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "events" ], "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": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "A health status for which the events will be returned.", "key": "healthStatus", "value": "VALID" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-f824f8d8-34db-43b6-b77f-4232947df193" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-82f6e64a-92dd-491f-8332-3f0226ec21c5" } ], "id": "5550d209-8a86-43ce-956a-9517034ee926", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-5550d209-8a86-43ce-956a-9517034ee926" }, { "name": "criteria", "item": [ { "name": "failedInstances", "item": [ { "name": "Get Failed Instances for a Data Health Criterion", "id": "c3b411d8-450d-410f-b1f8-464a492f6d5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/criteria/failedInstances?from=&to=&criterionId=&group=&scopeValue=&trackingId=&trackingId=&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "criteria", "failedInstances" ], "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": "(Required) The data health criterion for which the failed instances should be returned.", "key": "criterionId", "value": "" }, { "description": "(Required) The group for which data health information should be returned.", "key": "group", "value": "" }, { "description": "The value of the criterion scope for which failed instances should be returned. For example, if the scope of a rule is 'EVENT', the scope value could be 'Click', 'Search', etc. The failed instances would contain sample events of the specified type.", "key": "scopeValue", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "4dbcfb4c-7b49-43ad-a3be-2866476d3c31", "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/datahealth/criteria/failedInstances?from=&to=&criterionId=&group=&scopeValue=&trackingId=&page=0&perPage=50&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "criteria", "failedInstances" ], "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": "(Required) The data health criterion for which the failed instances should be returned.", "key": "criterionId", "value": "" }, { "description": "(Required) The group for which data health information should be returned.", "key": "group", "value": "" }, { "description": "The value of the criterion scope for which failed instances should be returned. For example, if the scope of a rule is 'EVENT', the scope value could be 'Click', 'Search', etc. The failed instances would contain sample events of the specified type.", "key": "scopeValue", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "50" }, { "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 \"failedInstances\": [\n {\n \"timestamp\": \"\",\n \"eventId\": \"\",\n \"visitId\": \"\",\n \"clientId\": \"\",\n \"scope\": \"EVENT\"\n },\n {\n \"timestamp\": \"\",\n \"eventId\": \"\",\n \"visitId\": \"\",\n \"clientId\": \"\",\n \"scope\": \"VISIT\"\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-4dbcfb4c-7b49-43ad-a3be-2866476d3c31" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-c3b411d8-450d-410f-b1f8-464a492f6d5d" } ], "id": "92c4097d-acac-41fe-9881-369c2893cbc6", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-92c4097d-acac-41fe-9881-369c2893cbc6" } ], "id": "38e5cdd0-ff92-4d26-a3cf-fb7f106a2b99", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-38e5cdd0-ff92-4d26-a3cf-fb7f106a2b99" }, { "name": "groups", "item": [ { "name": "detail", "item": [ { "name": "Get Detailed Information About a Data Health Group", "id": "465aa748-bb10-4960-ba2b-abbd4e834899", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/groups/detail?from=&to=&group=&category=&category=&feature=&feature=&trackingId=&trackingId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "groups", "detail" ], "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": "(Required) The group for which data health information should be returned.", "key": "group", "value": "" }, { "description": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "91496f6f-c5c9-456c-a2ad-aff44edf111a", "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/datahealth/groups/detail?from=&to=&group=&category=&feature=&trackingId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "groups", "detail" ], "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": "(Required) The group for which data health information should be returned.", "key": "group", "value": "" }, { "description": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "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 \"criteria\": [\n {\n \"id\": \"\",\n \"category\": \"\",\n \"severity\": \"LOW\",\n \"score\": \"\",\n \"scope\": \"\",\n \"scopeValue\": \"\",\n \"totalValidations\": \"\",\n \"failedValidations\": \"\"\n },\n {\n \"id\": \"\",\n \"category\": \"\",\n \"severity\": \"LOW\",\n \"score\": \"\",\n \"scope\": \"\",\n \"scopeValue\": \"\",\n \"totalValidations\": \"\",\n \"failedValidations\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-91496f6f-c5c9-456c-a2ad-aff44edf111a" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-465aa748-bb10-4960-ba2b-abbd4e834899" } ], "id": "4fcd213b-764e-4da2-be78-703700603104", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-4fcd213b-764e-4da2-be78-703700603104" }, { "name": "Get a Listing of Data Health Groups", "id": "3dbc238c-533a-4280-a29e-fe99bb5175f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/groups?from=&to=&category=&category=&feature=&feature=&trackingId=&trackingId=&page=0&perPage=10&org=&showEmptyGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "groups" ], "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": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "10" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether or not groups with zero event validated should be shown", "key": "showEmptyGroups", "value": "false" } ] } }, "response": [ { "id": "10dee997-3bd0-4a90-9422-e2f412959541", "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/datahealth/groups?from=&to=&category=&feature=&trackingId=&page=0&perPage=10&org=&showEmptyGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "groups" ], "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": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The response's page to access, starting at 0.", "key": "page", "value": "0" }, { "description": "The number of results to include in a page.", "key": "perPage", "value": "10" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether or not groups with zero event validated should be shown", "key": "showEmptyGroups", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groups\": [\n {\n \"group\": \"\",\n \"score\": \"\",\n \"totalValidations\": \"\",\n \"failedValidations\": \"\",\n \"severityBreakdown\": {\n \"ute\": \"\",\n \"deserunt_b\": \"\",\n \"deserunt_7bc\": \"\"\n }\n },\n {\n \"group\": \"\",\n \"score\": \"\",\n \"totalValidations\": \"\",\n \"failedValidations\": \"\",\n \"severityBreakdown\": {\n \"ea_52\": \"\",\n \"dolor_9\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-10dee997-3bd0-4a90-9422-e2f412959541" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-3dbc238c-533a-4280-a29e-fe99bb5175f7" } ], "id": "a76d2bff-5e18-4bae-9b6c-3c67f3430fc3", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-a76d2bff-5e18-4bae-9b6c-3c67f3430fc3" }, { "name": "overview", "item": [ { "name": "Get the Data Health Overview", "id": "bfa9ee6a-fd35-45a2-b569-6172ad8947e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/overview?from=&to=&category=&category=&feature=&feature=&trackingId=&trackingId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "overview" ], "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": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "a774f432-3d64-428f-90e3-3742e136a700", "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/datahealth/overview?from=&to=&category=&feature=&trackingId=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "overview" ], "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": "The categories of rules for which data health should be displayed.", "key": "category", "value": "" }, { "description": "The feature for which data health should be computed.", "key": "feature", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "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 \"score\": \"\",\n \"totalValidations\": \"\",\n \"failedValidations\": \"\",\n \"severityBreakdown\": {\n \"occaecat_d\": \"\",\n \"aliquae\": \"\",\n \"et_f7e\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-a774f432-3d64-428f-90e3-3742e136a700" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-bfa9ee6a-fd35-45a2-b569-6172ad8947e9" } ], "id": "300e38c0-529d-4e56-b38f-4a401eacace0", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-300e38c0-529d-4e56-b38f-4a401eacace0" }, { "name": "status", "item": [ { "name": "Get the Data Health Service Status", "id": "16bd321b-b7b4-4f6f-b30c-ad976c3a26f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "status" ] } }, "response": [ { "id": "0ffb6907-06d2-40e9-b9da-a13b1f56e952", "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/datahealth/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-0ffb6907-06d2-40e9-b9da-a13b1f56e952" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-16bd321b-b7b4-4f6f-b30c-ad976c3a26f6" } ], "id": "1f2fb7c5-ef00-4ef6-91e3-8abf986bea65", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-1f2fb7c5-ef00-4ef6-91e3-8abf986bea65" }, { "name": "facets", "item": [ { "name": "List Facet Values for Event Browser", "id": "754f1ace-fb96-440a-af90-124514709231", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/datahealth/facets?facet=EVENT_TYPE&from=&to=&clientId=&clientId=&visitId=&visitId=&eventSource=&eventSource=&eventType=&eventType=&searchHub=&searchHub=&trackingId=&trackingId=&healthStatus=VALID&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "facets" ], "query": [ { "description": "(Required) The facet for which the values should be listed", "key": "facet", "value": "EVENT_TYPE" }, { "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": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "A health status for which the events will be returned.", "key": "healthStatus", "value": "VALID" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "b4c3b8e0-0767-4985-8cd9-9c75c48d5ec9", "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/datahealth/facets?facet=EVENT_TYPE&from=&to=&clientId=&visitId=&eventSource=&eventType=&searchHub=&trackingId=&healthStatus=VALID&org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "datahealth", "facets" ], "query": [ { "description": "(Required) The facet for which the values should be listed", "key": "facet", "value": "EVENT_TYPE" }, { "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": "A set of client IDs for which the events will be returned.", "key": "clientId", "value": "" }, { "description": "A set of visit IDs for which the events will be returned.", "key": "visitId", "value": "" }, { "description": "A set of event sources for which the events will be returned.", "key": "eventSource", "value": "" }, { "description": "A set of event types for which the events will be returned.", "key": "eventType", "value": "" }, { "description": "A set of search hubs for which the events will be returned.", "key": "searchHub", "value": "" }, { "description": "The tracking IDs for which the results should be returned.", "key": "trackingId", "value": "" }, { "description": "A health status for which the events will be returned.", "key": "healthStatus", "value": "VALID" }, { "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 \"values\": [\n {\n \"count\": \"\",\n \"value\": {}\n },\n {\n \"count\": \"\",\n \"value\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-b4c3b8e0-0767-4985-8cd9-9c75c48d5ec9" } ], "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-754f1ace-fb96-440a-af90-124514709231" } ], "id": "342b00b3-3a48-4caa-b38f-0f2c99224471", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-342b00b3-3a48-4caa-b38f-0f2c99224471" } ], "id": "2e293c3e-f4c8-4ff1-a47c-077adc312512", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-2e293c3e-f4c8-4ff1-a47c-077adc312512" } ], "id": "8ec7f543-c667-41d7-89b3-818ed8ff9edc", "createdAt": "2026-07-28T01:27:40.000Z", "updatedAt": "2026-07-28T01:27:40.000Z", "uid": "35240-8ec7f543-c667-41d7-89b3-818ed8ff9edc" } ], "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" } ] }