{ "info": { "_postman_id": "faebaa32-ba9f-4ad6-af11-3d36659f08a9", "name": "Coveo Activity Activities License 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:29:14.000Z", "updatedAt": "2026-07-28T01:29:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-faebaa32-ba9f-4ad6-af11-3d36659f08a9" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "searchusagemetrics", "item": [ { "name": "license", "item": [ { "name": "all", "item": [ { "name": "Lists the Available Metrics for Reporting", "id": "70f7c659-eb52-4e1e-a5b5-62875593e890", "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/license/all", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "all" ], "variable": [ { "id": "a2a43ee9-7b58-414f-96ef-edbe6095c3fe", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "691a8763-ad4c-418d-9c95-06ecf2fb4e6d", "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/license/all", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "all" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-691a8763-ad4c-418d-9c95-06ecf2fb4e6d" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-70f7c659-eb52-4e1e-a5b5-62875593e890" } ], "id": "3cdd97ca-efb2-449c-97ae-c3a7bd3074b7", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-3cdd97ca-efb2-449c-97ae-c3a7bd3074b7" }, { "name": "assignable", "item": [ { "name": "Lists the Available Metrics for Assignment", "id": "44cd3f7a-f3b9-4763-bf9d-82b1ad01ba9c", "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/license/assignable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "assignable" ], "variable": [ { "id": "376915ab-f0c7-480b-ac07-ddca1adadcc2", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "1b9f0f16-2231-4e0e-8f5d-c4c6dee93263", "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/license/assignable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "assignable" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-1b9f0f16-2231-4e0e-8f5d-c4c6dee93263" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-44cd3f7a-f3b9-4763-bf9d-82b1ad01ba9c" } ], "id": "6d668e69-e3a2-4a3b-8ffc-a373a4a3227c", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-6d668e69-e3a2-4a3b-8ffc-a373a4a3227c" }, { "name": "daily", "item": [ { "name": "{metric}", "item": [ { "name": "Gets Per-Day Values for a Specific License Metric", "id": "14d89e2f-14b6-4af8-bbd3-f5b5844f5dc7", "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/license/daily/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "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": "d760be0c-2f13-47a8-b461-d28467f5e669", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "0dec40b5-17b2-44d8-b84f-617c51701e10", "key": "metric", "value": "", "description": "(Required) The license metric to report on" } ] } }, "response": [ { "id": "d0f29f37-c524-4490-a952-c313a37f40e8", "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/license/daily/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "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": "metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-d0f29f37-c524-4490-a952-c313a37f40e8" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-14d89e2f-14b6-4af8-bbd3-f5b5844f5dc7" } ], "id": "4bb36ea2-c800-499a-b93b-350defbdfd54", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-4bb36ea2-c800-499a-b93b-350defbdfd54" } ], "id": "2ece7851-3187-4ef1-beb4-71059036dcc6", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-2ece7851-3187-4ef1-beb4-71059036dcc6" }, { "name": "inUse", "item": [ { "name": "Lists the in-Use Metrics for an Organization", "id": "456b8757-3ab0-447c-ae75-aadf4f270d53", "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/license/inUse", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "inUse" ], "variable": [ { "id": "fbb42620-0777-4f62-9090-43582fb63b1d", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "204261f0-3444-450d-b9a9-7844c0a1fe1a", "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/license/inUse", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "inUse" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-204261f0-3444-450d-b9a9-7844c0a1fe1a" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-456b8757-3ab0-447c-ae75-aadf4f270d53" } ], "id": "e08251d9-3aa9-4e9e-9b13-51ca546c38ee", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-e08251d9-3aa9-4e9e-9b13-51ca546c38ee" }, { "name": "monthly", "item": [ { "name": "{metric}", "item": [ { "name": "Gets Per-Day Values for a Specific License Metric", "id": "7cb1193d-1df8-4007-a486-4d16c05757d6", "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/license/monthly/:metric?slidingWindow=&to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "monthly", ":metric" ], "query": [ { "description": "When appropriate, the size of the sliding window to use, in months. If this parameter is not specified the default sliding window for the metric will be used.", "key": "slidingWindow", "value": "" }, { "description": "(Required) The last month to report for", "key": "to", "value": "" }, { "description": "(Required) The first month to report for", "key": "from", "value": "" } ], "variable": [ { "id": "306083f0-8fa3-41b3-92ea-5e75f5da5c6c", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "d4448fd6-8787-47ec-a406-3b4ff9e84e9c", "key": "metric", "value": "", "description": "(Required) The license metric to report on" } ] } }, "response": [ { "id": "8d0cb105-7fb0-4200-ba3a-3f30fe53a411", "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/license/monthly/:metric?slidingWindow=&to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "monthly", ":metric" ], "query": [ { "description": "When appropriate, the size of the sliding window to use, in months. If this parameter is not specified the default sliding window for the metric will be used.", "key": "slidingWindow", "value": "" }, { "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": "metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-8d0cb105-7fb0-4200-ba3a-3f30fe53a411" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-7cb1193d-1df8-4007-a486-4d16c05757d6" } ], "id": "81d51f48-1fe6-4730-a256-02b8d3f27378", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-81d51f48-1fe6-4730-a256-02b8d3f27378" } ], "id": "52e124ad-3b23-4e2d-b621-ce3ba5f4b594", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-52e124ad-3b23-4e2d-b621-ce3ba5f4b594" }, { "name": "total", "item": [ { "name": "{metric}", "item": [ { "name": "Gets Total Values for a Specific License Metric Over a Specified Month Range", "id": "fe445609-8938-4ff3-aebc-20a9c80d517a", "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/license/total/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "total", ":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": "b4f1ac9c-c4a9-46f5-ab50-5a676190df12", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "cb4fa8fd-ee36-4f3e-97b6-308d73d2a26a", "key": "metric", "value": "", "description": "(Required) The license metric to report on" } ] } }, "response": [ { "id": "82a64d7b-3cd6-444b-89f8-17adedc9c846", "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/license/total/:metric?to=&from=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "license", "total", ":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": "metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-82a64d7b-3cd6-444b-89f8-17adedc9c846" } ], "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-fe445609-8938-4ff3-aebc-20a9c80d517a" } ], "id": "033c78f1-6681-499f-b131-a92bfd2f7bbf", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-033c78f1-6681-499f-b131-a92bfd2f7bbf" } ], "id": "8b8902fb-5aca-4d02-9f92-4b52990ffc28", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-8b8902fb-5aca-4d02-9f92-4b52990ffc28" } ], "id": "bbe254bc-9014-4ad7-9880-0defc43ad91c", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-bbe254bc-9014-4ad7-9880-0defc43ad91c" } ], "id": "8621a788-4ebd-4935-8170-8689e3bc725a", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-8621a788-4ebd-4935-8170-8689e3bc725a" } ], "id": "da7cf92e-6e11-4777-8db5-c5a64c8496f5", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-da7cf92e-6e11-4777-8db5-c5a64c8496f5" } ], "id": "96adc0f8-c48f-417f-8d52-7b12d2e6be55", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-96adc0f8-c48f-417f-8d52-7b12d2e6be55" } ], "id": "20a840bc-c641-433d-bc55-fe548e0370d6", "createdAt": "2026-07-28T01:29:15.000Z", "updatedAt": "2026-07-28T01:29:15.000Z", "uid": "35240-20a840bc-c641-433d-bc55-fe548e0370d6" } ], "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" } ] }