{ "info": { "_postman_id": "84078a4e-3773-4b1a-bf71-3b0d8eb5076e", "name": "Coveo Activity Activities Search Hubs API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "lastUpdatedBy": "35240", "uid": "35240-84078a4e-3773-4b1a-bf71-3b0d8eb5076e" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "searchusagemetrics", "item": [ { "name": "hubs", "item": [ { "name": "{hubName}", "item": [ { "name": "bucket", "item": [ { "name": "Updates a Search Hub Bucket in an Organization, Creating the Hub If Required", "id": "35af1bc1-2ecd-44c9-b3e6-352aff403460", "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": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName/bucket?bucket=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName", "bucket" ], "query": [ { "description": "(Required) The search hub bucket", "key": "bucket", "value": "" } ], "variable": [ { "id": "3d933736-d71b-4738-8a76-e311fe51ee98", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "1afd15a5-491e-4ff1-9fe7-32f9d912e430", "key": "hubName", "value": "", "description": "(Required) The search hub name" } ] } }, "response": [ { "id": "741ffdb2-d763-45fd-b618-967bbc4e02b3", "name": "No response", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName/bucket?bucket=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName", "bucket" ], "query": [ { "description": "(Required) The search hub bucket", "key": "bucket", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "hubName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-741ffdb2-d763-45fd-b618-967bbc4e02b3" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-35af1bc1-2ecd-44c9-b3e6-352aff403460" } ], "id": "9b0c3e4f-5a1b-408a-a0d4-2183135bf546", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-9b0c3e4f-5a1b-408a-a0d4-2183135bf546" }, { "name": "Deletes a Search Hub for an Organization", "id": "28f35dd6-c8fb-4e76-905a-e528ea7eee51", "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": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "id": "ebda8f1c-31be-45fc-9bf8-fddc7e2c2d23", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "929c8f49-70eb-4b8e-a0dd-fb803fe2df42", "key": "hubName", "value": "", "description": "(Required) The search hub name" } ] } }, "response": [ { "id": "3c63c9a7-7397-441a-80f3-30d5cb05531c", "name": "No response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "key": "organizationId" }, { "key": "hubName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-3c63c9a7-7397-441a-80f3-30d5cb05531c" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-28f35dd6-c8fb-4e76-905a-e528ea7eee51" }, { "name": "Gets a Specific Search Hub for an Organization", "id": "ad40cd26-60cc-4b8f-8f02-0b62ec2cfb32", "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/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "id": "044a6587-6c46-4ce5-95f1-2453b437e072", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "00994136-cefe-4739-b59d-1fc257699ba2", "key": "hubName", "value": "", "description": "(Required) The search hub name" } ] } }, "response": [ { "id": "b3fe224f-30fd-40f4-8499-8dfc73b3610d", "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/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "key": "organizationId" }, { "key": "hubName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-b3fe224f-30fd-40f4-8499-8dfc73b3610d" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-ad40cd26-60cc-4b8f-8f02-0b62ec2cfb32" }, { "name": "Updates a Search Hub in an Organization", "id": "b7338ff3-628c-4c3f-b627-7793e72f8fea", "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": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "id": "5306af2d-7ffe-4cfe-999e-1b2763e5e811", "key": "organizationId", "value": "", "description": "(Required) The organization ID" }, { "id": "e1137056-311e-436d-af57-2b36c7e09c96", "key": "hubName", "value": "", "description": "(Required) The search hub name" } ] } }, "response": [ { "id": "2786d4ff-edec-4160-9e3c-be5347134787", "name": "No response", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", ":hubName" ], "variable": [ { "key": "organizationId" }, { "key": "hubName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-2786d4ff-edec-4160-9e3c-be5347134787" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-b7338ff3-628c-4c3f-b627-7793e72f8fea" } ], "id": "23177870-3fd9-497d-b892-435352122f48", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-23177870-3fd9-497d-b892-435352122f48" }, { "name": "Creates a Search Hub in the Organization", "id": "e2c78dfc-8a11-49ae-b65d-7d97176db16b", "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": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", "" ], "variable": [ { "id": "c99d8fc2-d4e9-47db-af55-5a0b142f2400", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "ac34ee27-c281-4221-a02b-6f58718e404e", "name": "No response", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchusagemetrics/hubs/", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", "" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-ac34ee27-c281-4221-a02b-6f58718e404e" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-e2c78dfc-8a11-49ae-b65d-7d97176db16b" }, { "name": "Lists the Search Hubs for an Organization", "id": "f799e7e4-4e58-4c2e-8832-2d5722fe836a", "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/hubs/?minimumQueries=&filter=&pageSize=&page=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", "" ], "query": [ { "description": "The minimum number of queries required for a search hub to be listed", "key": "minimumQueries", "value": "" }, { "description": "The free-form string to filter the returned list based on the values of the search hub attributes.", "key": "filter", "value": "" }, { "description": "The maximum number of organizations to list per page.", "key": "pageSize", "value": "" }, { "description": "The 0-based index number of the page to list.", "key": "page", "value": "" } ], "variable": [ { "id": "423e2046-ef17-4db9-a5d3-1db108005831", "key": "organizationId", "value": "", "description": "(Required) The organization ID" } ] } }, "response": [ { "id": "15de2786-41ba-4c55-98fb-558a2fb99446", "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/hubs/?minimumQueries=&filter=&pageSize=&page=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchusagemetrics", "hubs", "" ], "query": [ { "description": "The minimum number of queries required for a search hub to be listed", "key": "minimumQueries", "value": "" }, { "description": "The free-form string to filter the returned list based on the values of the search hub attributes.", "key": "filter", "value": "" }, { "description": "The maximum number of organizations to list per page.", "key": "pageSize", "value": "" }, { "description": "The 0-based index number of the page to list.", "key": "page", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-15de2786-41ba-4c55-98fb-558a2fb99446" } ], "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-f799e7e4-4e58-4c2e-8832-2d5722fe836a" } ], "id": "a66b4d6a-0d0c-407a-a14f-d044bc613d68", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-a66b4d6a-0d0c-407a-a14f-d044bc613d68" } ], "id": "82a4c5e0-03a5-4d50-908e-6af9c52e6d17", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-82a4c5e0-03a5-4d50-908e-6af9c52e6d17" } ], "id": "3579f9ce-6f38-410c-ab5f-2ade01c737a9", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-3579f9ce-6f38-410c-ab5f-2ade01c737a9" } ], "id": "bd150868-c231-43f7-84a3-1425653091db", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-bd150868-c231-43f7-84a3-1425653091db" } ], "id": "b2dbdb0d-e1f4-402f-a90f-d3d0328bb6fb", "createdAt": "2026-07-28T01:31:36.000Z", "updatedAt": "2026-07-28T01:31:36.000Z", "uid": "35240-b2dbdb0d-e1f4-402f-a90f-d3d0328bb6fb" } ], "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" } ] }