{ "info": { "_postman_id": "a0923363-d11d-4125-a4cd-e0db9e6bfc84", "name": "Coveo Activity Activities Raw Metrics 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:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "lastUpdatedBy": "35240", "uid": "35240-a0923363-d11d-4125-a4cd-e0db9e6bfc84" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "searchusagemetrics", "item": [ { "name": "raw", "item": [ { "name": "all", "item": [ { "name": "Lists the Available Metrics for Assignment", "id": "abce2a99-269d-4c0d-9334-63ed921dbdd8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/all", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "all" ], "variable": [ { "id": "915e0481-c8a4-4203-be94-e1536930780a", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "07a58794-2f2d-40f1-9db4-b03fc7bc9d84", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/all", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "all" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:40.000Z", "updatedAt": "2026-07-28T01:30:40.000Z", "uid": "35240-07a58794-2f2d-40f1-9db4-b03fc7bc9d84" } ], "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-abce2a99-269d-4c0d-9334-63ed921dbdd8" } ], "id": "bc7ee837-dbc1-4ada-9bd6-515931e47964", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-bc7ee837-dbc1-4ada-9bd6-515931e47964" }, { "name": "monthly", "item": [ { "name": "Gets Raw Metric Values for a Specific Month", "id": "6bdbd0ab-d054-4325-a55e-a952e30a195c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/monthly?minimumQueries=&month=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "monthly" ], "query": [ { "description": "The minimum number of queries required for a search hub to be listed", "key": "minimumQueries", "value": "" }, { "description": "(Required) The month to report for", "key": "month", "value": "" } ], "variable": [ { "id": "e512be73-7a90-4a7b-ab2c-03fa346a9a3a", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "cda68c73-1584-4821-b8c8-91ca4acb287d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/monthly?minimumQueries=&month=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "monthly" ], "query": [ { "description": "The minimum number of queries required for a search hub to be listed", "key": "minimumQueries", "value": "" }, { "description": "(Required) The month to report for", "key": "month", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:40.000Z", "updatedAt": "2026-07-28T01:30:40.000Z", "uid": "35240-cda68c73-1584-4821-b8c8-91ca4acb287d" } ], "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-6bdbd0ab-d054-4325-a55e-a952e30a195c" } ], "id": "70bd2c18-5232-4d08-83dd-bccb3b54f1e5", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-70bd2c18-5232-4d08-83dd-bccb3b54f1e5" }, { "name": "searchhubs", "item": [ { "name": "{searchHub}", "item": [ { "name": "daily", "item": [ { "name": "{metric}", "item": [ { "name": "Gets Daily Raw Values for a Specific Search Hub and Metric", "id": "bd794867-d12d-437c-ae91-090a4547130f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/searchhubs/:searchHub/daily/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "searchhubs", ":searchHub", "daily", ":metric" ], "query": [ { "description": "(Required) The last day to report for", "key": "to", "value": "" }, { "description": "(Required) The first day to report for", "key": "from", "value": "" } ], "variable": [ { "id": "42f1e67e-edb7-4e4f-a6d4-8ff81dee6581", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "a086d4ea-befb-46c2-9f70-e279fb574ac2", "key": "searchHub", "value": "", "description": "(Required) The name of the search hub to report on" }, { "id": "bccc7cae-00ef-402e-83ea-e011ab2504e6", "key": "metric", "value": "", "description": "(Required) The raw metric to report on" } ] } }, "response": [ { "id": "9c0d01e0-f853-41b7-83de-2096a60f7248", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/searchhubs/:searchHub/daily/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "searchhubs", ":searchHub", "daily", ":metric" ], "query": [ { "description": "(Required) The last day to report for", "key": "to", "value": "" }, { "description": "(Required) The first day to report for", "key": "from", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "searchHub" }, { "key": "metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:40.000Z", "updatedAt": "2026-07-28T01:30:40.000Z", "uid": "35240-9c0d01e0-f853-41b7-83de-2096a60f7248" } ], "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-bd794867-d12d-437c-ae91-090a4547130f" } ], "id": "c258d405-f3df-4da4-ab0a-9a97f50147d3", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-c258d405-f3df-4da4-ab0a-9a97f50147d3" } ], "id": "a4224f59-01e0-4166-b2be-f29a76b6f707", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-a4224f59-01e0-4166-b2be-f29a76b6f707" }, { "name": "monthly", "item": [ { "name": "{metric}", "item": [ { "name": "Gets Monthly Raw Values for a Specific Search Hub and Metric", "id": "dcc2e6a5-a587-483f-af69-d578d4310ba1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/searchhubs/:searchHub/monthly/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "searchhubs", ":searchHub", "monthly", ":metric" ], "query": [ { "description": "(Required) The last month to report for", "key": "to", "value": "" }, { "description": "(Required) The first month to report for", "key": "from", "value": "" } ], "variable": [ { "id": "99363d6a-5805-4ea6-a18e-8491c11ec68d", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "82a64b5e-2e17-4c35-a9f0-d45d4380751f", "key": "searchHub", "value": "", "description": "(Required) The name of the search hub to report on" }, { "id": "2e4faae1-c6b6-4830-b425-8c2872a67b03", "key": "metric", "value": "", "description": "(Required) The raw metric to report on" } ] } }, "response": [ { "id": "667a6546-79e8-41f2-bd94-564e95663518", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/raw/searchhubs/:searchHub/monthly/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "raw", "searchhubs", ":searchHub", "monthly", ":metric" ], "query": [ { "description": "(Required) The last month to report for", "key": "to", "value": "" }, { "description": "(Required) The first month to report for", "key": "from", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "searchHub" }, { "key": "metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:40.000Z", "updatedAt": "2026-07-28T01:30:40.000Z", "uid": "35240-667a6546-79e8-41f2-bd94-564e95663518" } ], "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-dcc2e6a5-a587-483f-af69-d578d4310ba1" } ], "id": "c564f105-6fac-4717-b92a-c4f04e577c87", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-c564f105-6fac-4717-b92a-c4f04e577c87" } ], "id": "173a4e1f-3790-4967-a128-9b59437aac6d", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-173a4e1f-3790-4967-a128-9b59437aac6d" } ], "id": "2b11a1ac-cae6-44f5-a24d-824b6d74bdaf", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-2b11a1ac-cae6-44f5-a24d-824b6d74bdaf" } ], "id": "6914877a-5e66-4632-83b3-160697256532", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-6914877a-5e66-4632-83b3-160697256532" } ], "id": "bd91d245-f2f4-414a-b79d-e3c14cff8973", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-bd91d245-f2f4-414a-b79d-e3c14cff8973" } ], "id": "dfcb36d8-d21a-4d01-a69c-c806a6701500", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-dfcb36d8-d21a-4d01-a69c-c806a6701500" } ], "id": "1cb440cc-b976-4a55-bfdc-6cdd79aa896b", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-1cb440cc-b976-4a55-bfdc-6cdd79aa896b" } ], "id": "4120b8a3-55bc-46a7-8dea-ba417b764614", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-4120b8a3-55bc-46a7-8dea-ba417b764614" } ], "id": "c66e5b72-9ee3-4ac6-93a4-471f024792b2", "createdAt": "2026-07-28T01:30:39.000Z", "updatedAt": "2026-07-28T01:30:39.000Z", "uid": "35240-c66e5b72-9ee3-4ac6-93a4-471f024792b2" } ], "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" } ] }