{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Search Hubs API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Search Hubs", "type": "folder" }, "items": [ { "info": { "name": "Lists the Search Hubs for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/", "params": [ { "name": "minimumQueries", "value": "", "type": "query", "description": "The minimum number of queries required for a search hub to be listed" }, { "name": "filter", "value": "", "type": "query", "description": "The free-form string to filter the returned list based on the values of the search hub attributes." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of organizations to list per page." }, { "name": "page", "value": "", "type": "query", "description": "The 0-based index number of the page to list." }, { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the Search Hubs for an Organization" }, { "info": { "name": "Creates a Search Hub in the Organization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Search Hub in the Organization" }, { "info": { "name": "Gets a Specific Search Hub for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "params": [ { "name": "hubName", "value": "", "type": "path", "description": "The search hub name" }, { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a Specific Search Hub for an Organization" }, { "info": { "name": "Updates a Search Hub in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "params": [ { "name": "hubName", "value": "", "type": "path", "description": "The search hub name" }, { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a Search Hub in an Organization" }, { "info": { "name": "Deletes a Search Hub for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName", "params": [ { "name": "hubName", "value": "", "type": "path", "description": "The search hub name" }, { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a Search Hub for an Organization" }, { "info": { "name": "Updates a Search Hub Bucket in an Organization, Creating the Hub If Required", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/hubs/:hubName/bucket", "params": [ { "name": "bucket", "value": "", "type": "query", "description": "The search hub bucket" }, { "name": "hubName", "value": "", "type": "path", "description": "The search hub name" }, { "name": "organizationId", "value": "", "type": "path", "description": "The organization ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a Search Hub Bucket in an Organization, Creating the Hub If Required" } ] } ], "bundled": true }