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 Result rankings API

The Result rankings API from Coveo — 8 operation(s) for result rankings.

Coveo Result rankings 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 Result rankings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 11 operations across 8 paths, and defines 71 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.

11 operations 8 paths 71 schemas 1 DELETE2 GET7 POST1 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 Result rankings 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 11

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

Result rankings 11
GET
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings
Get a List of Result Ranking Rules
listResultRankingRules 13 params → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings
Create a New Result Ranking Rule
createResultRankingRule 2 params body → 200400401403419429
GET
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}
Get a Result Ranking Rule
getResultRankingRule 3 params → 200400401403419429
PUT
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}
Update a Result Ranking Rule
updateResultRankingRule 3 params body → 204400401403419429
DELETE
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}
Delete a Result Ranking Rule
deleteResultRankingRule 3 params → 204400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/bulkGet
Bulk Get Result Ranking Rules
bulkGetResultRankingOperation 9 params body → 200400401403419422429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/bulkDelete
Bulk Delete Result Rankings Rules from a Pipeline
bulkDeleteRankingRules 2 params body → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/copy
Copy Result Rankings Rules to a Pipeline.
copyResultRankingRule 2 params body → 201400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/duplicate/{resultRankingId}
Duplicate a Result Ranking Rule
duplicateResultRankingRule 3 params → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/validate
Validate a Single Result Ranking Operation.
validateResultRankingOperation 2 params body → 200400401403419422429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/validate/batch
Validate a Batch of Result Ranking Operations.
validateResultRankingOperations 2 params body → 200400401403419422429503

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are ResultRankingRuleResponseBase (7 properties), ResultRankingRuleBase (7 properties), ResultRankingRuleRankingExpressionBase (6 properties), ResultRankingRuleFeaturedResultsBase (5 properties). Each schema is shown below with its type and property counts.

ResultRankingRuleFeaturedResultsResponse
ResultRankingRuleGetResponse
StatementGroupStatus
string
The status of the campaign.
ResultRankingValidationRequest
Predicate
ByStatus
object
2 properties 2 required
ByGroup
object
2 properties 2 required
ConditionDetailed
object
1 property 1 required
ResultRankingRuleGetBaseResponse
object
2 properties 1 required
ResultRankingGroupByResponse
object
3 properties 3 required
ResultRankingRuleTargetFeaturedResults
ResultRankingRuleFeaturedResultsBase
object
5 properties 2 required
ResultRankingRuleTargetQueryExpression
object
1 property 1 required
ResultRankingRuleIdentifiedWithGroupStatusListResponse
object
3 properties 2 required
RestBulkGetRequest
object
1 property
ResultRankingRuleAssociatedGroupWithStatus
object
3 properties 2 required
ResultRankingListResponse
object
4 properties 4 required
ResultRankingRuleCreateRequest
CopyResultRankingRulesRequest
object
2 properties 2 required
ResultRankingRuleListResponseBase
ResultRankingRuleRankingExpressionCreateRequest
ResultRankingRuleTargetLocalizedContent
object
1 property 1 required
ResultRankingRuleType
string
ResultRankingRuleRankingExpressionListResponse
ResultRankingRuleIdentifiedResponse
object
2 properties 2 required
BulkDeleteResultRankingRulesResponse
object
ResultRankingRuleResponse
OperatorRightHandSide
ResultRankingRuleOperationValidateUpdate
object
3 properties 3 required
IsBetweenOperator
object
4 properties 4 required
RestOperationValidationError
object
1 property 1 required
ResultRankingRuleIdOnlyResponse
object
1 property 1 required
ResultRankingRuleFeaturedResultsCreateRequest
ResultRankingRuleBase
object
7 properties 1 required
ResultRankingBatchOperationValidate
object
1 property 1 required
BulkDeleteResultRankingRulesRequest
object
1 property 1 required
ResultRankingRuleLocalizedContent
object
4 properties 4 required
ResultRankingRuleRankingExpressionGetResponse
ResultRankingRuleConditionListResponse
object
2 properties
ResultRankingRuleResponseBase
object
7 properties 1 required
PredicateQpl
object
2 properties 2 required
CompoundBooleanExpression
object
3 properties 2 required
ResultRankingRuleCondition
object
1 property
ResultRankingRuleFeaturedResultsGetResponse
BooleanExpression
PredicateLocale
object
2 properties
ResultRankingRuleUpdateRequest
BulkGetResultRankingRuleIdentifiedWithGroupStatusResponse
object
3 properties 2 required
ResultRankingRuleFeaturedResultsListResponse
RestBatchOperationValidationResponse
object
1 property 1 required
ResultRankingRuleRankingExpressionBase
object
6 properties 3 required
ResultRankingRuleRankingExpressionResponse
OperatorExpression
object
3 properties 2 required
ResultRankingRuleLocalizedContentLocaleAuto
object
1 property 1 required
OperationValidateDelete
object
2 properties 2 required
ResultRankingRuleStatus
string
ResultRankingSingleOperationValidate
object
1 property 1 required
PredicateMatchOperator
object
1 property
PredicateBasicExpression
object
4 properties 1 required
ByType
object
2 properties 2 required
ResultRankingRuleListResponse
RestOperationValidationResponse
object
4 properties 2 required
ResultRankingRuleLocalizedContentLocale
object
Exactly one field should be defined.
2 properties
RestSingleOperationValidationResponse
object
1 property 1 required
ResultRankingRuleIdentifiedWithGroupStatusResponse
object
3 properties 2 required
ResultRankingRuleOperationValidateCreate
object
2 properties 2 required
CopyResultRankingRulesResponse
object
1 property 1 required
ResultRankingRuleTargetUniqueId
object
1 property 1 required
ErrorMessage
object
3 properties
OperatorLeftHandSide
object
3 properties 1 required
ResultRankingBulkGetResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-result-rankings-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 Result rankings 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.