{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Groups API - Version 15 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": "Groups API - Version 15", "type": "folder" }, "items": [ { "info": { "name": "Gets All Groups for Account.", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Gets All Groups for Account." }, { "info": { "name": "Gets the Data Level Filters That Apply to the Specified Group.", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups/:groupId/filters", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier of a group." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Gets the Data Level Filters That Apply to the Specified Group." }, { "info": { "name": "Set the Filters That Will Be Applied to the Specified Group's Query", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/v15/groups/:groupId/filters", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier of a group." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the Filters That Will Be Applied to the Specified Group's Query" }, { "info": { "name": "Get a Group.", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier of a group." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Get a Group." }, { "info": { "name": "Gets the Reports That the Specified Group Can Access.", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups/:groupId/reports", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier of a group." }, { "name": "org", "value": "", "type": "query", "description": "The unique identifier of a user." }, { "name": "includeConfig", "value": "", "type": "query", "description": "Whether to include the detailed configuration of the report in the response." } ] }, "docs": "Gets the Reports That the Specified Group Can Access." }, { "info": { "name": "Set Which Reports the Specified Group Can Access.", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/v15/groups/:groupId/reports", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier of a group." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Which Reports the Specified Group Can Access." }, { "info": { "name": "Health Check for the Groups Service", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups/monitoring/health" }, "docs": "Health Check for the Groups Service" }, { "info": { "name": "Get the Groups Service Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/groups/status" }, "docs": "Get the Groups Service Status" } ] } ], "bundled": true }