{ "info": { "_postman_id": "486a2126-69e4-4be7-9817-868154e989bc", "name": "Coveo Activity Activities Reports 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:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-486a2126-69e4-4be7-9817-868154e989bc" }, "item": [ { "name": "v14", "item": [ { "name": "reports", "item": [ { "name": "{reportId}", "item": [ { "name": "users", "item": [ { "name": "Gets the Users That Can View the Specified Report.", "id": "11a76030-05c7-431e-beca-7c13902b3d4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/reports/:reportId/users?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId", "users" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "2ea89f42-081e-4e7b-a283-6afb990587ab", "key": "reportId", "value": "", "description": "(Required) The unique identifier of a report. This id is generated by the server when creating a report." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "81268bdb-002b-4798-88c9-97762d53b6d4", "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/reports/:reportId/users?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId", "users" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access\": \"PUBLIC\",\n \"allowedUsers\": [\n {\n \"userId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n },\n {\n \"userId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-81268bdb-002b-4798-88c9-97762d53b6d4" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-11a76030-05c7-431e-beca-7c13902b3d4d" }, { "name": "Set the Users Who Are Allowed to View a Report", "id": "60f702fb-748d-42e1-abef-121bd5320c82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports/:reportId/users?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId", "users" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "892527f0-c092-43d8-8e19-254952e7237c", "key": "reportId", "value": "", "description": "(Required) The unique identifier of a report. This id is generated by the server when creating a report." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "3c226aff-9de1-4de5-a7ce-8240edc6369b", "name": "No content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports/:reportId/users?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId", "users" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "reportId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-3c226aff-9de1-4de5-a7ce-8240edc6369b" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-60f702fb-748d-42e1-abef-121bd5320c82" } ], "id": "17124e4a-b7ae-4f39-9391-d28d278f0ca4", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-17124e4a-b7ae-4f39-9391-d28d278f0ca4" }, { "name": "Get a Report", "id": "4f23c4fb-8cd0-4465-9fb5-13c428c0b22f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "24bb2072-d75c-43d1-8f0b-d05895b658bd", "key": "reportId", "value": "", "description": "(Required) The unique identifier of a report. This id is generated by the server when creating a report." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "00dffd6f-76c0-4849-954d-337e111ebf74", "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/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"cillum_29\": {},\n \"laborum_9\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-00dffd6f-76c0-4849-954d-337e111ebf74" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-4f23c4fb-8cd0-4465-9fb5-13c428c0b22f" }, { "name": "Update a Report", "id": "0dc3783f-99aa-4ea1-9b8a-789e72941d6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allAnalyticsViewer\": \"\",\n \"configuration\": {\n \"id_ca9\": {},\n \"dolore003\": {}\n },\n \"displayName\": \"\",\n \"type\": \"DASHBOARD\",\n \"filters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "7ab4dd40-3328-41ae-bffa-fff8153d452f", "key": "reportId", "value": "", "description": "(Required) The unique identifier of a report. This id is generated by the server when creating a report." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "5c852d2a-3f3f-4a29-8542-d77193e5d9a5", "name": "OK", "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 \"allAnalyticsViewer\": \"\",\n \"configuration\": {\n \"id_ca9\": {},\n \"dolore003\": {}\n },\n \"displayName\": \"\",\n \"type\": \"DASHBOARD\",\n \"filters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-5c852d2a-3f3f-4a29-8542-d77193e5d9a5" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-0dc3783f-99aa-4ea1-9b8a-789e72941d6b" }, { "name": "Delete a Report", "id": "46c405ee-8a1d-46af-b549-65aa9a766da3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v14/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "e6510675-574c-473d-adc1-255ed87fca40", "key": "reportId", "value": "", "description": "(Required) The unique identifier of a report. This id is generated by the server when creating a report." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "0361ca9c-1649-44e4-b6f9-bb6593629ed2", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/reports/:reportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", ":reportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "reportId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-0361ca9c-1649-44e4-b6f9-bb6593629ed2" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-46c405ee-8a1d-46af-b549-65aa9a766da3" } ], "id": "28ca47a1-32c9-445f-951c-fbfb8c2d001e", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-28ca47a1-32c9-445f-951c-fbfb8c2d001e" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Reports Service", "id": "77ba8d7b-d8ca-4f22-8929-20adae49eef0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/reports/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", "monitoring", "health" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "36f21825-bd6c-498f-9498-24c86f165bc3", "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/reports/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-36f21825-bd6c-498f-9498-24c86f165bc3" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-77ba8d7b-d8ca-4f22-8929-20adae49eef0" } ], "id": "8847fb14-b8c4-4ddc-8b02-84572d3cf7dd", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-8847fb14-b8c4-4ddc-8b02-84572d3cf7dd" } ], "id": "759f03cc-2ad2-4b26-889e-d4673234f38c", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-759f03cc-2ad2-4b26-889e-d4673234f38c" }, { "name": "status", "item": [ { "name": "Get the Reports Service Status", "id": "8e457318-41ad-460f-b562-abd03f4924c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/reports/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", "status" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "f27141c7-8916-445a-b9d8-2f04ba8a7502", "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/reports/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-f27141c7-8916-445a-b9d8-2f04ba8a7502" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-8e457318-41ad-460f-b562-abd03f4924c4" } ], "id": "04b55368-6ede-43e8-b55e-05c98e9624b5", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-04b55368-6ede-43e8-b55e-05c98e9624b5" }, { "name": "Get the Persisted Reports of One or All Types", "id": "e522e4ef-b706-4301-9b0f-d46bd227ca8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/reports?type=DASHBOARD&org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports" ], "query": [ { "description": "The type of the report. Must be either 'explorer' or 'dashboard'.", "key": "type", "value": "DASHBOARD" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "ef7755bb-60b3-4dd8-9ea7-1f887781be45", "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/reports?type=DASHBOARD&org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports" ], "query": [ { "description": "The type of the report. Must be either 'explorer' or 'dashboard'.", "key": "type", "value": "DASHBOARD" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"reports\": [\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"non_\": {},\n \"non_f4f\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"pariatur_0\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-ef7755bb-60b3-4dd8-9ea7-1f887781be45" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-e522e4ef-b706-4301-9b0f-d46bd227ca8c" }, { "name": "Create a Report", "id": "4b3646ff-0459-45e7-b7b1-d03544564ae5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allAnalyticsViewer\": \"\",\n \"configuration\": {\n \"id_ca9\": {},\n \"dolore003\": {}\n },\n \"displayName\": \"\",\n \"type\": \"DASHBOARD\",\n \"filters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports" ], "query": [ { "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": "285ebd58-c64d-4339-a59c-48bc6ab8c310", "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 \"allAnalyticsViewer\": \"\",\n \"configuration\": {\n \"id_ca9\": {},\n \"dolore003\": {}\n },\n \"displayName\": \"\",\n \"type\": \"DASHBOARD\",\n \"filters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v14/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "reports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-285ebd58-c64d-4339-a59c-48bc6ab8c310" } ], "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-4b3646ff-0459-45e7-b7b1-d03544564ae5" } ], "id": "13f18736-5f61-4d2a-b532-9ada1d8f7e8d", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-13f18736-5f61-4d2a-b532-9ada1d8f7e8d" } ], "id": "f40c9a15-5467-46db-9e6d-460f110cabc0", "createdAt": "2026-07-28T01:31:22.000Z", "updatedAt": "2026-07-28T01:31:22.000Z", "uid": "35240-f40c9a15-5467-46db-9e6d-460f110cabc0" } ], "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" } ] }