{ "info": { "_postman_id": "982c1cfb-abf8-4ac0-a013-8778a974735b", "name": "Coveo Activity Activities Metadata 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:29:25.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "lastUpdatedBy": "35240", "uid": "35240-982c1cfb-abf8-4ac0-a013-8778a974735b" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "sources", "item": [ { "name": "{sourceId}", "item": [ { "name": "metadata", "item": [ { "name": "status", "item": [ { "name": "Get the Status of Metadata Reports for a Source", "id": "ec1f7931-b543-4a96-b84c-2eddf3476788", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata", "status" ], "variable": [ { "id": "6c5ca3a8-ca08-4e4a-8598-dce9a6735d71", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "9b840445-91a5-415e-aae8-4f6eba7695a0", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "6b6ccab6-5049-4f42-8ca4-bee62823305b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata", "status" ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"sampleAvailable\": \"\",\n \"reportGenerationInProgress\": \"\",\n \"reportAvailable\": \"\"\n}", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-6b6ccab6-5049-4f42-8ca4-bee62823305b" } ], "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-ec1f7931-b543-4a96-b84c-2eddf3476788" } ], "id": "9b44ffc0-c79c-4f64-8748-a3723c3c0679", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-9b44ffc0-c79c-4f64-8748-a3723c3c0679" }, { "name": "Retrieve Metadata Report for a Source", "id": "e93bfdf8-1cd8-42a4-9bbe-edbc32ebbf6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata?page=0&perPage=100&filter=&sortBy=&order=ASC", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata" ], "query": [ { "key": "page", "value": "0" }, { "key": "perPage", "value": "100" }, { "description": "Optional filter string. Must be at least 2 characters long to be applied.", "key": "filter", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "order", "value": "ASC" } ], "variable": [ { "id": "199ef332-14b4-448a-9c11-623cfa05832b", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "2e407027-9289-4024-9e8d-04fcbbcf5239", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "9bf69175-8d9e-464a-9d2a-39c40c7fcf0a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata?page=0&perPage=100&filter=&sortBy=&order=ASC", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata" ], "query": [ { "key": "page", "value": "0" }, { "key": "perPage", "value": "100" }, { "description": "Optional filter string. Must be at least 2 characters long to be applied.", "key": "filter", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "order", "value": "ASC" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"key\": \"\",\n \"values\": [\n {\n \"metadataValue\": {},\n \"count\": \"\"\n },\n {\n \"metadataValue\": {},\n \"count\": \"\"\n }\n ],\n \"count\": \"\",\n \"origin\": \"\",\n \"isMapped\": \"\",\n \"indexedBy\": \"FIELD\"\n },\n {\n \"key\": \"\",\n \"values\": [\n {\n \"metadataValue\": {},\n \"count\": \"\"\n },\n {\n \"metadataValue\": {},\n \"count\": \"\"\n }\n ],\n \"count\": \"\",\n \"origin\": \"\",\n \"isMapped\": \"\",\n \"indexedBy\": \"FIELD\"\n }\n ],\n \"creationDate\": \"\",\n \"expirationDate\": \"\",\n \"sampledDocumentCount\": \"\",\n \"documentErrorCount\": \"\",\n \"totalPages\": \"\",\n \"totalEntries\": \"\"\n}", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-9bf69175-8d9e-464a-9d2a-39c40c7fcf0a" } ], "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-e93bfdf8-1cd8-42a4-9bbe-edbc32ebbf6c" }, { "name": "Create Metadata Report for a Source", "id": "6ba4f1b8-9160-484a-908a-7f9f83d238b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata" ], "variable": [ { "id": "7fe6c86b-83ec-4afe-883f-33bb7e31e094", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "dd51058d-efce-4f01-a62b-2b340ea0fbcf", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "57b86b45-e93d-4676-9c7b-313c2f26a118", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/sources/:sourceId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "sources", ":sourceId", "metadata" ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-57b86b45-e93d-4676-9c7b-313c2f26a118" } ], "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-6ba4f1b8-9160-484a-908a-7f9f83d238b6" } ], "id": "a1cbf05d-0e75-4657-9661-4ce10fef803e", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-a1cbf05d-0e75-4657-9661-4ce10fef803e" } ], "id": "8b30f5b1-3df2-4920-84f9-bc884e735f19", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-8b30f5b1-3df2-4920-84f9-bc884e735f19" } ], "id": "ba2ee238-de31-40d7-8483-ff3edf4d5454", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-ba2ee238-de31-40d7-8483-ff3edf4d5454" } ], "id": "701e2d55-0591-49b8-a2cd-2b419006c136", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-701e2d55-0591-49b8-a2cd-2b419006c136" } ], "id": "c779846a-fb77-4d3b-b87e-9183e542f705", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-c779846a-fb77-4d3b-b87e-9183e542f705" } ], "id": "c882064f-78dd-485f-b82b-d5979ac28b92", "createdAt": "2026-07-28T01:29:26.000Z", "updatedAt": "2026-07-28T01:29:26.000Z", "uid": "35240-c882064f-78dd-485f-b82b-d5979ac28b92" } ], "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" } ] }