{ "info": { "_postman_id": "98d34a98-d632-4eda-a918-7f180c3150d7", "name": "Coveo Activity Activities Exports 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:28:09.000Z", "updatedAt": "2026-07-28T01:28:09.000Z", "lastUpdatedBy": "35240", "uid": "35240-98d34a98-d632-4eda-a918-7f180c3150d7" }, "item": [ { "name": "v15", "item": [ { "name": "exports", "item": [ { "name": "schedules", "item": [ { "name": "{exportScheduleId}", "item": [ { "name": "exports", "item": [ { "name": "Get Exports Generated by the Specified Schedule", "id": "d4d6a0c7-9fc3-4032-af54-3f37152dd6cb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId/exports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId", "exports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "44b1a306-8d4e-4b9d-935a-46f52d47fb88", "key": "exportScheduleId", "value": "", "description": "(Required) The export schedule's unique identifier." } ] } }, "response": [ { "id": "bcdb5028-604b-4e48-9a5d-01ef2a349999", "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/exports/schedules/:exportScheduleId/exports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId", "exports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportScheduleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"laboris_9_4\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"EXPIRED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n },\n {\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"esse80b\": \"\",\n \"aliqua_6_\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"EXPIRED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-bcdb5028-604b-4e48-9a5d-01ef2a349999" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-d4d6a0c7-9fc3-4032-af54-3f37152dd6cb" } ], "id": "b3a52175-099e-40fb-9998-6bbb5add1b63", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-b3a52175-099e-40fb-9998-6bbb5add1b63" }, { "name": "Get Information on an Export Schedule", "id": "da653b57-40d8-43d7-bc29-ae725b0f48ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "328dd4bc-86fa-4f63-9936-2ce8808681ec", "key": "exportScheduleId", "value": "", "description": "(Required) The export schedule's unique identifier." } ] } }, "response": [ { "id": "2bf7de11-e7fa-4cac-a71b-df8f190730c0", "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/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportScheduleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"author\": \"\",\n \"description\": \"\",\n \"filters\": {\n \"non_8\": \"\",\n \"occaecat7\": \"\"\n },\n \"frequency\": \"MONTHLY\",\n \"id\": \"\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"\",\n \"\"\n ],\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-2bf7de11-e7fa-4cac-a71b-df8f190730c0" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-da653b57-40d8-43d7-bc29-ae725b0f48ab" }, { "name": "Update an Existing Export Schedule", "id": "30347c06-ee99-4a6d-af07-83bdbb77e631", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"frequency\": \"WEEKLY\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"tables\": [\n \"KEYWORDS\",\n \"SEARCHES\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "f6f0db8c-758a-44b7-81a9-9ab7840e9a9f", "key": "exportScheduleId", "value": "", "description": "(Required) The export schedule's unique identifier." } ] } }, "response": [ { "id": "a13e65f9-73f8-447f-b5a1-2f519e319484", "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 \"frequency\": \"WEEKLY\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"tables\": [\n \"KEYWORDS\",\n \"SEARCHES\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportScheduleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"author\": \"\",\n \"description\": \"\",\n \"filters\": {\n \"non_8\": \"\",\n \"occaecat7\": \"\"\n },\n \"frequency\": \"MONTHLY\",\n \"id\": \"\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"\",\n \"\"\n ],\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-a13e65f9-73f8-447f-b5a1-2f519e319484" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-30347c06-ee99-4a6d-af07-83bdbb77e631" }, { "name": "Delete an Export Schedule", "id": "377e5071-6e84-4d76-bfcc-9ca48ba9bda6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "2bfdfe3c-560e-48be-b640-50f6f38514aa", "key": "exportScheduleId", "value": "", "description": "(Required) The export schedule's unique identifier." } ] } }, "response": [ { "id": "130e537c-71d2-49be-b303-cf8c1d2fcfc5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/exports/schedules/:exportScheduleId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules", ":exportScheduleId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportScheduleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-130e537c-71d2-49be-b303-cf8c1d2fcfc5" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-377e5071-6e84-4d76-bfcc-9ca48ba9bda6" } ], "id": "0bc6994b-f653-44dd-b602-3850ec68c99f", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-0bc6994b-f653-44dd-b602-3850ec68c99f" }, { "name": "Get All the Export Schedules", "id": "75e27288-0003-45a4-86c7-0bbd19ae0156", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/schedules?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "5bdd8a01-e406-4467-85bc-25120600e508", "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/exports/schedules?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules" ], "query": [ { "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 \"author\": \"\",\n \"description\": \"\",\n \"filters\": {\n \"commodofd\": \"\",\n \"adipisicing_a\": \"\",\n \"dolore_00\": \"\"\n },\n \"frequency\": \"MONTHLY\",\n \"id\": \"\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"\",\n \"\"\n ],\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n },\n {\n \"author\": \"\",\n \"description\": \"\",\n \"filters\": {\n \"Loremb_\": \"\",\n \"magna0\": \"\",\n \"ex0bc\": \"\",\n \"voluptate7bc\": \"\"\n },\n \"frequency\": \"MONTHLY\",\n \"id\": \"\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"SATURDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"\",\n \"\"\n ],\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-5bdd8a01-e406-4467-85bc-25120600e508" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-75e27288-0003-45a4-86c7-0bbd19ae0156" }, { "name": "Create an Export Schedule", "id": "d1f5d503-1483-4dd6-a6be-52697943e47a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"frequency\": \"WEEKLY\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"tables\": [\n \"KEYWORDS\",\n \"SEARCHES\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/schedules?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "c973deeb-9fdb-4a83-b424-1cfcf6c99a88", "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 \"frequency\": \"WEEKLY\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"tables\": [\n \"KEYWORDS\",\n \"SEARCHES\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/schedules?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "schedules" ], "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 \"author\": \"\",\n \"description\": \"\",\n \"filters\": {\n \"non_8\": \"\",\n \"occaecat7\": \"\"\n },\n \"frequency\": \"MONTHLY\",\n \"id\": \"\",\n \"timezone\": \"\",\n \"dayOfWeek\": \"WEDNESDAY\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"\",\n \"\"\n ],\n \"usingDisplayNames\": \"\",\n \"notificationsEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-c973deeb-9fdb-4a83-b424-1cfcf6c99a88" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-d1f5d503-1483-4dd6-a6be-52697943e47a" } ], "id": "daf1c8a0-31eb-4466-8111-9cddad0147d6", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-daf1c8a0-31eb-4466-8111-9cddad0147d6" }, { "name": "{exportId}", "item": [ { "name": "downloadlink", "item": [ { "name": "Get the Download Link of an Export", "id": "96b1d65e-f00c-4822-859d-785aeb37a2d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/:exportId/downloadlink?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId", "downloadlink" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "171e3be9-97a6-4448-b778-bfaf1614451d", "key": "exportId", "value": "", "description": "(Required) The export's unique identifier." } ] } }, "response": [ { "id": "f18fe374-c2de-4778-9813-1fe942ea5c60", "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/exports/:exportId/downloadlink?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId", "downloadlink" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"downloadLink\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-f18fe374-c2de-4778-9813-1fe942ea5c60" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-96b1d65e-f00c-4822-859d-785aeb37a2d1" } ], "id": "5c35c3c7-b384-49f2-acb4-5e083b84c371", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-5c35c3c7-b384-49f2-acb4-5e083b84c371" }, { "name": "Get Information on an Export", "id": "e6632a04-1c10-4e31-8029-dd48613e0d2e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/:exportId?org=&redirect=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface.", "key": "redirect", "value": "false" } ], "variable": [ { "id": "5f3848b7-e8fc-44be-afee-ec62496a8489", "key": "exportId", "value": "", "description": "(Required) The export's unique identifier." } ] } }, "response": [ { "id": "1452ce3d-ea56-468a-8fd7-897917c5d96b", "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/exports/:exportId?org=&redirect=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface.", "key": "redirect", "value": "false" } ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"reprehenderit6\": \"\",\n \"commodo72\": \"\",\n \"in_5f3\": \"\",\n \"mollitef7\": \"\",\n \"occaecat_7a\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"FAILED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-1452ce3d-ea56-468a-8fd7-897917c5d96b" }, { "id": "ec67bcce-408c-4670-9673-3c342525d67b", "name": "Responds with See Other, if the redirect parameter is used", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/exports/:exportId?org=&redirect=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface.", "key": "redirect", "value": "false" } ], "variable": [ { "key": "exportId" } ] } }, "status": "See Other", "code": 303, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-ec67bcce-408c-4670-9673-3c342525d67b" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-e6632a04-1c10-4e31-8029-dd48613e0d2e" }, { "name": "Delete an Export", "id": "6279c6ab-b546-481c-8527-96a2ff765f45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v15/exports/:exportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "2a968253-50c2-4ae3-b864-ea2833aa09a6", "key": "exportId", "value": "", "description": "(Required) The export's unique identifier." } ] } }, "response": [ { "id": "6123dcb7-9bf8-4748-9848-8a1b6a176f49", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/exports/:exportId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", ":exportId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "exportId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-6123dcb7-9bf8-4748-9848-8a1b6a176f49" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-6279c6ab-b546-481c-8527-96a2ff765f45" } ], "id": "6c802b45-9baa-4511-813e-e3a85cda100b", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-6c802b45-9baa-4511-813e-e3a85cda100b" }, { "name": "estimate", "item": [ { "name": "Estimate the Number of Rows in an Export", "id": "47fb49e0-bff2-4927-92a0-6640276d01e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/estimate?org=&from=&to=&tables=SEARCHES&tables=GROUPS&f=&f=&fs=&fs=&fc=&fc=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "estimate" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "SEARCHES" }, { "description": "The tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "GROUPS" }, { "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" } ] } }, "response": [ { "id": "40af42d5-2be5-4f9d-b4c6-a2c9fd2a25d8", "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/exports/estimate?org=&from=&to=&tables=GROUPS&f=&fs=&fc=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "estimate" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "GROUPS" }, { "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"estimates\": {\n \"adipisicing_334\": \"\"\n }\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-40af42d5-2be5-4f9d-b4c6-a2c9fd2a25d8" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-47fb49e0-bff2-4927-92a0-6640276d01e1" } ], "id": "838fc9c7-9448-427a-ab12-320b18a64ce4", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-838fc9c7-9448-427a-ab12-320b18a64ce4" }, { "name": "visits", "item": [ { "name": "estimate", "item": [ { "name": "Estimate the Number of Rows in a Visit Export", "id": "2f5ea62b-3f0b-4846-9a47-bc027f31c6a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/visits/estimate?org=&from=&to=&f=&f=&hideEventFilters=&hideEventFilters=&fn=&fn=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits", "estimate" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 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": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" } ] } }, "response": [ { "id": "e606f914-e414-4961-bb8a-eb28e333ef12", "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/exports/visits/estimate?org=&from=&to=&f=&hideEventFilters=&fn=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits", "estimate" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"estimates\": {\n \"adipisicing_334\": \"\"\n }\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-e606f914-e414-4961-bb8a-eb28e333ef12" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-2f5ea62b-3f0b-4846-9a47-bc027f31c6a1" } ], "id": "594d740e-4120-407e-8472-08b9df82e7f5", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-594d740e-4120-407e-8472-08b9df82e7f5" }, { "name": "create", "item": [ { "name": "Generate a Visit Export (with Parameters as Request Body)", "id": "63bebdfe-e949-44c3-bdf0-29306a044b16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"inclusionFilters\": [\n \"\",\n \"\"\n ],\n \"hideEventFilters\": [\n \"\",\n \"\"\n ],\n \"exclusionFilters\": [\n \"\",\n \"\"\n ],\n \"filename\": \"\",\n \"description\": \"\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"useDisplayNames\": false,\n \"ordered\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/visits/create?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits", "create" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "a6c89c34-5f8c-4219-bbf9-3d2a0144ec72", "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 \"from\": \"\",\n \"to\": \"\",\n \"inclusionFilters\": [\n \"\",\n \"\"\n ],\n \"hideEventFilters\": [\n \"\",\n \"\"\n ],\n \"exclusionFilters\": [\n \"\",\n \"\"\n ],\n \"filename\": \"\",\n \"description\": \"\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"useDisplayNames\": false,\n \"ordered\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/visits/create?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits", "create" ], "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 \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"reprehenderit6\": \"\",\n \"commodo72\": \"\",\n \"in_5f3\": \"\",\n \"mollitef7\": \"\",\n \"occaecat_7a\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"FAILED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-a6c89c34-5f8c-4219-bbf9-3d2a0144ec72" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-63bebdfe-e949-44c3-bdf0-29306a044b16" } ], "id": "4d111b2e-939f-4383-804e-6f1f84a192eb", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-4d111b2e-939f-4383-804e-6f1f84a192eb" }, { "name": "Generate a Visit Export", "id": "029accec-7924-4766-9d0d-7ec95f7dde9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/visits?org=&from=&to=&f=&f=&hideEventFilters=&hideEventFilters=&fn=&fn=&filename=&d=&dimensions=&dimensions=&format=EXCEL&ordered=true&useDisplayNames=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 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": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.", "key": "filename", "value": "" }, { "description": "Export's description.", "key": "d", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The format of the generated CSV files.", "key": "format", "value": "EXCEL" }, { "description": "Whether to order the rows by datetime in the export. If the number of rows exported is to great, this parameter will be ignored and data will be unsorted.", "key": "ordered", "value": "true" }, { "description": "Whether to use the display names in the export's header. If false, the api names will be used.", "key": "useDisplayNames", "value": "false" } ] } }, "response": [ { "id": "f35b4377-2afc-43d2-a3af-1e9bd2075e50", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/exports/visits?org=&from=&to=&f=&hideEventFilters=&fn=&filename=&d=&dimensions=&format=EXCEL&ordered=true&useDisplayNames=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "visits" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.", "key": "hideEventFilters", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.", "key": "filename", "value": "" }, { "description": "Export's description.", "key": "d", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The format of the generated CSV files.", "key": "format", "value": "EXCEL" }, { "description": "Whether to order the rows by datetime in the export. If the number of rows exported is to great, this parameter will be ignored and data will be unsorted.", "key": "ordered", "value": "true" }, { "description": "Whether to use the display names in the export's header. If false, the api names will be used.", "key": "useDisplayNames", "value": "false" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"reprehenderit6\": \"\",\n \"commodo72\": \"\",\n \"in_5f3\": \"\",\n \"mollitef7\": \"\",\n \"occaecat_7a\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"FAILED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-f35b4377-2afc-43d2-a3af-1e9bd2075e50" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-029accec-7924-4766-9d0d-7ec95f7dde9a" } ], "id": "644e2aef-80b6-4d5b-a396-b4105f2d89dd", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-644e2aef-80b6-4d5b-a396-b4105f2d89dd" }, { "name": "create", "item": [ { "name": "Generate an Export (with Parameters as Request Body)", "id": "5713fef8-f7d4-4550-8ebb-246a335104a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"filename\": \"\",\n \"description\": \"\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"KEYWORDS\",\n \"CUSTOM_EVENTS\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"useDisplayNames\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/create?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "create" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "ec67a1eb-abee-44a8-a57b-d2c5cf11288e", "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 \"from\": \"\",\n \"to\": \"\",\n \"commonFilters\": [\n \"\",\n \"\"\n ],\n \"searchesFilters\": [\n \"\",\n \"\"\n ],\n \"customEventsFilters\": [\n \"\",\n \"\"\n ],\n \"filename\": \"\",\n \"description\": \"\",\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"tables\": [\n \"KEYWORDS\",\n \"CUSTOM_EVENTS\"\n ],\n \"exportFormat\": \"EXCEL\",\n \"useDisplayNames\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/exports/create?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "create" ], "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 \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"reprehenderit6\": \"\",\n \"commodo72\": \"\",\n \"in_5f3\": \"\",\n \"mollitef7\": \"\",\n \"occaecat_7a\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"FAILED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-ec67a1eb-abee-44a8-a57b-d2c5cf11288e" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-5713fef8-f7d4-4550-8ebb-246a335104a9" } ], "id": "1b907daa-7c23-4e75-84c0-4470fc596913", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-1b907daa-7c23-4e75-84c0-4470fc596913" }, { "name": "rowLimit", "item": [ { "name": "Get the Maximum Allowed Number of Rows an Export Can Have", "id": "6a978da8-1b5c-4f38-9edb-ce6330c24816", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/rowLimit?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "rowLimit" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "839e3e63-cc7d-4902-a632-4365d290491f", "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/exports/rowLimit?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "rowLimit" ], "query": [ { "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 \"exportRowCountLimit\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-839e3e63-cc7d-4902-a632-4365d290491f" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-6a978da8-1b5c-4f38-9edb-ce6330c24816" } ], "id": "54663e91-a478-4bbc-a8f1-ba8dbbaf3d6b", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-54663e91-a478-4bbc-a8f1-ba8dbbaf3d6b" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Exports Service", "id": "d260428e-561f-4818-afc1-539a32f0506c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "monitoring", "health" ] } }, "response": [ { "id": "6041d554-aa4b-4b3f-8be5-26cfaaf1bf2a", "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/exports/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-6041d554-aa4b-4b3f-8be5-26cfaaf1bf2a" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-d260428e-561f-4818-afc1-539a32f0506c" } ], "id": "166ccbd6-b33e-4e19-a693-b7d0ad9ee675", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-166ccbd6-b33e-4e19-a693-b7d0ad9ee675" } ], "id": "e63664d6-2347-49f8-bc2f-9af043f9a3a1", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-e63664d6-2347-49f8-bc2f-9af043f9a3a1" }, { "name": "status", "item": [ { "name": "Get the Exports Service Status", "id": "853431d3-42ce-4450-b3dd-0f049a6293ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "status" ] } }, "response": [ { "id": "2d37f28c-5288-4b53-8893-50064e7dc934", "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/exports/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-2d37f28c-5288-4b53-8893-50064e7dc934" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-853431d3-42ce-4450-b3dd-0f049a6293ab" } ], "id": "9ebaf220-f3c6-44e3-a34c-0a16bba8d84d", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-9ebaf220-f3c6-44e3-a34c-0a16bba8d84d" }, { "name": "Lists All Exports", "id": "595ede3c-e2cd-41ee-8927-35cb1565dcad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "f3cb5de9-52f8-4bc4-9d44-c4637844f0b2", "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/exports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports" ], "query": [ { "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 \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"laboris_9_4\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"EXPIRED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n },\n {\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"esse80b\": \"\",\n \"aliqua_6_\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"EXPIRED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-f3cb5de9-52f8-4bc4-9d44-c4637844f0b2" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-595ede3c-e2cd-41ee-8927-35cb1565dcad" }, { "name": "Generate an Export", "id": "34d9d41e-7283-452a-9361-5e2247abb97b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/exports?org=&from=&to=&f=&f=&fs=&fs=&fc=&fc=&filename=&d=&dimensions=&dimensions=&tables=SEARCHES&tables=GROUPS&format=EXCEL&useDisplayNames=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" }, { "description": "A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.", "key": "filename", "value": "" }, { "description": "Export's description.", "key": "d", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "SEARCHES" }, { "description": "The tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "GROUPS" }, { "description": "The format of the generated CSV files.", "key": "format", "value": "EXCEL" }, { "description": "Whether to use the display names in the export's header. If false, the api names will be used.", "key": "useDisplayNames", "value": "false" } ] } }, "response": [ { "id": "47098ecb-c98b-40e3-9cc0-932311fb9d6b", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v15/exports?org=&from=&to=&f=&fs=&fc=&filename=&d=&dimensions=&tables=GROUPS&format=EXCEL&useDisplayNames=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "exports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "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 filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fs", "value": "" }, { "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "fc", "value": "" }, { "description": "A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.", "key": "filename", "value": "" }, { "description": "Export's description.", "key": "d", "value": "" }, { "description": "The dimensions that will be exported. If not provided, all dimensions will be exported.", "key": "dimensions", "value": "" }, { "description": "The tables that will be exported. If not provided, all tables will be exported.", "key": "tables", "value": "GROUPS" }, { "description": "The format of the generated CSV files.", "key": "format", "value": "EXCEL" }, { "description": "Whether to use the display names in the export's header. If false, the api names will be used.", "key": "useDisplayNames", "value": "false" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"author\": \"\",\n \"description\": \"\",\n \"downloadable\": \"\",\n \"filters\": {\n \"reprehenderit6\": \"\",\n \"commodo72\": \"\",\n \"in_5f3\": \"\",\n \"mollitef7\": \"\",\n \"occaecat_7a\": \"\"\n },\n \"from\": \"\",\n \"id\": \"\",\n \"size\": \"\",\n \"startDate\": \"\",\n \"status\": \"FAILED\",\n \"to\": \"\",\n \"downloadLink\": \"\",\n \"tables\": [\n \"\",\n \"\"\n ],\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"replayable\": \"\",\n \"usingDisplayNames\": \"\",\n \"scheduleId\": \"\"\n}", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-47098ecb-c98b-40e3-9cc0-932311fb9d6b" } ], "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-34d9d41e-7283-452a-9361-5e2247abb97b" } ], "id": "7aa4b255-6af8-45fd-b253-4a6e3b91e172", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-7aa4b255-6af8-45fd-b253-4a6e3b91e172" } ], "id": "1dd86cc3-a53b-4d8a-b26d-3f2f207e2005", "createdAt": "2026-07-28T01:28:10.000Z", "updatedAt": "2026-07-28T01:28:10.000Z", "uid": "35240-1dd86cc3-a53b-4d8a-b26d-3f2f207e2005" } ], "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" } ] }