How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Statement groups API

The Statement groups API from Coveo — 8 operation(s) for statement groups.

Coveo Statement groups API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Statement groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 12 operations across 8 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

12 operations 8 paths 35 schemas 1 DELETE3 GET1 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@coveo.com
Terms of Service
Resource Areas
1

Authentication & Security 4

Coveo Statement groups API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (platformTokens). It accepts HTTP bearer tokens (JWT) (searchTokens). It accepts HTTP bearer tokens (apiKey).

  • oauth2 — This API uses OAuth 2 with the implicit grant flow.
  • platformTokens — Platform tokens are used to authenticate requests to the platform as a specific user. See [Use platform token authentication](https://docs.coveo.com/en/n3ge002…
  • searchTokens — Search tokens are used to authenticate search-related API requests. See [Use search token authentication](https://docs.coveo.com/en/56).
  • apiKey — API keys are used to authenticate requests to the platform as a specific user. See [Use API key authentication with the Search API](https://docs.coveo.com/en/1…

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 1 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Statement groups 12
GET
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups
List Statement Groups of a Pipeline
listStatementGroups 9 params → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups
Create a New Statement Group
createStatementGroup 2 params body → 201400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/associations/dissociate
Dissociate Pipeline Rules Associated to Groups
statementGroupsAssociationsDissociate 2 params body → 200400401403419422429503
POST
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/bulkGet
List Statement Groups of a Pipeline
bulkGetStatementGroupsOperation 4 params body → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate
Validate a Single Statement Group Operation.
validateStatementGroupOperation 2 params body → 200400401403419422429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate/batch
Validate a Batch of Statement Groups Operations.
validateStatementGroupsOperations 2 params body → 200400401403419422429503
GET
/rest/search/admin/pipelines/featureActiveState
Returns the List of All Pipeline Features and Whether They're Active or Not.
getFeatureActiveState 1 param → 200
GET
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}
Get a Statement Group of a Pipeline
Get a statement group of a pipeline 3 params → 200400401403419429503
DELETE
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}
Delete a Statement Group of a Pipeline
Delete a statement group of a pipeline 3 params → 204400401403419422429503
PUT
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}
Update a Statement Group
Update a statement group 3 params body → 204400401403419422429503
PATCH
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}
Toggle a Permanent Group
Toggle a permanent group 3 params body → 204400401403419422429503
PUT
/rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}/associations
Update the Rules Associated with a Statement Group
updateStatementGroupsAssociations 3 params body → 200400401403419422429503

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are GetStatementGroupBase (13 properties), CreateStatementGroupResponse (8 properties), PipelineGroupsComposition (6 properties), ProblemDetailResponse (5 properties). Each schema is shown below with its type and property counts.

CreateStatementGroupResponse
object
8 properties 3 required
GetStatementGroupBase
object
13 properties 6 required
ListFeatureActiveStateResponse
object
1 property 1 required
StatementGroupAssociationItem
object
An object representing a rule to associate to a group.
2 properties 2 required
DissociateStatementGroupAssociationsRequest
object
1 property
RestOperationValidationRequestCreateStatementGroupRequest
object
3 properties 1 required
UpdateStatementGroupAssociationsRequest
object
2 properties
CreateOrUpdateCampaignGroup
GetPermanentGroupBase
object
2 properties 1 required
RestBatchOperationValidationResponse
object
1 property 1 required
ListStatementGroupsResponse
object
3 properties 3 required
StatementGroupStatus
string
The status of the campaign.
RestBatchOperationValidationRequestCreateStatementGroupRequest
object
1 property 1 required
RestOperationValidationResponse
object
4 properties 2 required
PipelineGroupsComposition
object
6 properties 6 required
GetCampaignGroup
ProblemDetailResponse
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
5 properties
GetPermanentGroup
CreateOrUpdatePermanentGroupBase
object
1 property 1 required
CreateOrUpdatePermanentGroup
GetStatementGroup
CreateOrUpdateStatementGroupBase
object
4 properties 2 required
RestSingleOperationValidationResponse
object
1 property 1 required
StatementGroupComposition
object
2 properties 2 required
CreateOrUpdateStatementGroup
FeatureActiveState
object
2 properties 2 required
CreateOrUpdateCampaignGroupBase
object
2 properties 2 required
StatementGroupType
string
The type name of the statement group.
UpdateStatementGroupAssociationsResponse
object
1 property 1 required
RestSingleOperationValidationRequestCreateStatementGroupRequest
object
1 property 1 required
RestBulkGetRequest
object
1 property
RestOperationValidationError
object
1 property 1 required
ErrorMessage
object
3 properties
GetCampaignGroupBase
object
3 properties
TogglePermanentGroupRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-statement-groups-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Statement groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.