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 Analysis V3 API

The Analysis V3 API from Coveo — 2 operation(s) for analysis v3.

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

This API exposes 2 operations across 2 paths, and defines 101 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.

2 operations 2 paths 101 schemas 2 POST

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 Analysis V3 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Analysis V3 2
POST
/rest/search/v3/analysis/expressions/structured
Convert Query to Structured Expression
parseExpressionToStructured 1 param body → 200400401403419422
POST
/rest/search/v3/analysis/inspect/replay
Replay a Query with Inspection Details
replay 1 param body → 200400401403404419422429

Schemas 101

The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are PreprocessingStateResponse (13 properties), IntegrationQueryFunction (6 properties), IntegrationRankingExpression (6 properties), ProblemDetailResponse (5 properties). Each schema is shown below with its type and property counts.

ReplayExecutionStepPostprocessingIntegrations
object
4 properties 2 required
ReplayExecutionStepParamOverridesRule
IntegrationErrorInfo
object
2 properties 2 required
NewExpressionV2
As the expressions evolve, new expressions types might be added. To be forward compatible, you should always handle cases where something else could be returne…
ReplayExecutionStepART
object
3 properties 2 required
ParseQueryExpressionToStructuredResponse
object
1 property 1 required
QueryExtensionInvocationExpressionV2
object
3 properties 3 required
ReplayExecutionStepPipelineSelectionPipeline
object
3 properties 2 required
ProblemDetailResponse
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
5 properties
FieldExistsExpressionV2
object
2 properties 2 required
ReplayIntegrationPostprocessingOutcome
EmptyExpressionV2
object
1 property 1 required
ReplayRankingInfoQueryRankingExpression
object
4 properties 3 required
ReplayRankingInfoTermsWeight
object
2 properties 2 required
ReplayExecutionStepProductRecommendation
object
3 properties 2 required
IntegrationRankingExpression
object
6 properties 4 required
QueryExpressionSupportedV2
ReplayExecutionStepIntegrationsPostprocessingRule
ReplayExecutionStepTriggers
object
3 properties 2 required
ReplayExecutionStepFilters
object
3 properties 2 required
TextExpressionV2
ReplayExecutionStepProductRecommendationRule
TextExpressionSupportedV2
ReplayRankingInfoWeightComposition
object
3 properties
InspectReplayResponse
object
4 properties 4 required
ObjectAccessExpressionV2
object
3 properties 2 required
PostprocessingStateResponse
object
1 property
ListOfExecutionSteps
object
2 properties 1 required
ReplayExecutionStepPipelineSelection
object
4 properties 4 required
ReplayModelRule
object
3 properties 2 required
ReplayExecutionStepRankingExpressionsRuleBase
object
1 property
ReplayExecutionStepStopWords
object
3 properties 2 required
ReplayExecutionStepRules
NearExpressionV2
object
3 properties 3 required
ReplayIntegrationsPostprocessingRule
ReplayRankingInfoQueryRankingExpressionRule
object
2 properties 1 required
ReplayExecutionStepRankingWeightsRule
ReplayExecutionStepIntegrationsPreprocessingRule
ReplayRankingInfoWeights
object
Map of ranking factors and respective scores.
ReplayExecutionStepDNERule
FieldValueSupportedV2
NotKeywordExpressionV2
FieldOperatorV2
string
The comparison to make against the value.
ReplayExecutionStepThesaurusRule
ExactMatchExpressionV2
object
2 properties 2 required
QuerySyntaxExpressionV2
object
2 properties 2 required
AndExpressionV2
object
2 properties 2 required
ParseQueryExpressionToStructuredRequest
object
1 property 1 required
ReplayExecutionStepPreprocessingIntegrations
object
3 properties 2 required
PreprocessingStateResponse
object
13 properties
ReplayExecutionStepDNE
object
3 properties 3 required
ReplayExecutionStepThesaurus
object
3 properties 2 required
StringValueV2
object
A value containing a string.
2 properties 2 required
ReplayAffectedResults
object
1 property
FeatureVector
object
IntegrationQueryFunction
object
6 properties 2 required
FieldExpressionV2
object
4 properties 4 required
DateValueV2
object
2 properties 2 required
ReplayExecutionStepParamOverrides
object
3 properties 2 required
ReplayExecutionStepRankingWeights
object
3 properties 2 required
ReplayIntegrationsPreprocessingChanges
object
1 property
ReplayExecutionStepStopWordsRule
ReplayRankingInfo
object
3 properties 2 required
ReplayExecutionStepRankingExpressions
object
3 properties 2 required
ReplayIntegrationsPostprocessingChanges
object
1 property
NumericValueV2
object
2 properties 2 required
ReplayExecutionStepFiltersRule
KeywordExpressionV2
object
Test
3 properties 2 required
ReplayExecutionStepRankingExpressionsRule
ReplayResult
object
4 properties 3 required
ReplayAffectedRequestParameters
object
1 property 1 required
ReplayExecutionStepFeaturedResults
object
3 properties 2 required
IntegrationRankingFunction
object
5 properties 2 required
ReplayExecutionStepFeaturedResultsRule
ReplayRule
object
2 properties 1 required
ReplayIntegrationsProcessingFailure
object
1 property 1 required
TermsToContainExpressionV2
object
An expression where each terms should exist in an item.
2 properties 2 required
DateRangeValueV2
object
2 properties 2 required
ReplayIntegrationsPreprocessingRule
ReplayExecutionStepTriggersRule
DictionaryFieldContext
object
ReplayAffectedRequestParameter
object
2 properties 1 required
RankingOrigin
object
3 properties 2 required
ReplayExecutionStepARTRule
ReplayExecutionStepContentRecommendationRule
QueryExpressionV2
FieldValueV2
InspectReplayRequest
object
2 properties 1 required
ReplayExecutionStepBase
object
1 property 1 required
ReplayCondition
object
1 property 1 required
ReplayExecutionStepIndexQuery
object
3 properties 3 required
ReplayIntegrationsBase
object
3 properties 2 required
UnknownValueV2
object
2 properties 2 required
ReplayExecutionStepSpecific
OrExpressionV2
object
2 properties 2 required
ReplayExecutionStepRulesBase
ReplayExecutionStep
ErrorMessage
object
3 properties
ReplayIntegrationPreprocessingOutcome
NotExpressionV2
object
2 properties 2 required
ReplayExecutionStepContentRecommendation
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-analysis-v3-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 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
Coveo Built-in Groups API
Where this information came from

This is an independent, third-party profile of Coveo Analysis V3 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.