Coveo Search 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 Search (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
14 operations
across 14 paths,
and defines 120 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.
The identity and technical contract details declared by the specification.
FindFieldsRequest
object
2 properties
FindFieldsResponse
object
1 property
1 required
RestFacetValueNumericalRangeBase
object
2 properties
2 required
RestListFieldValuesBatchParameterBase
object
1 property
1 required
CommerceParameters
object
3 properties
RestQueryCorrection
object
2 properties
2 required
RestFacetRequestSpecificSortCriteriaExplicitAlphanumeric
object
2 properties
1 required
Debug
booleannull
Whether to force a successful response to include debug information. Notes: - Debug information can only appear in responses in the JSON format (see the format…
RestFieldAliases
object
A key-value store where each pair corresponds to the name of an alias, along with the key to target within which dictionary field to query. Note: This cannot b…
RestFacetResultDomain
object
The domain of the facet. It represents the lowest and highest values possible for this facet. Note: This property is only populated when the facet is a range f…
2 properties
RestFacetResult
object
8 properties
4 required
DQ
string
The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the que…
RestQuerySuggestParameters
RestGroupByValue
object
11 properties
6 required
RestFacetRequestSpecificBaseAllowedValues
RestFacetRequestNumericalRange
Locale
stringnull
The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition. Coveo Machine Learning models use thi…
RestQuestionAnswer
object
7 properties
6 required
SearchHub
stringnull
The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates. Coveo Machine Learning…
RestFacetResultValue
object
8 properties
2 required
RestFacetRequestSpecificBaseAllowedValuesSimple
object
The field values allowed in the facet operation results. If you do not explicitly specify an array of allowedValues, or if you specify an empty array, all fiel…
2 properties
2 required
RestFacetSearchParametersHierarchical
object
11 properties
1 required
Pipeline
stringnull
The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty pipeline value to use an empty query pi…
RestFacetRequestNumericalRangeBase
object
3 properties
1 required
RestFacetValueBase
object
3 properties
RestListFieldValuesBatchParameter
RestComputedField
object
2 properties
2 required
RestListFieldValuesParameterBase
object
12 properties
1 required
AQ
string
The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, t…
CQ
string
The constant query expression, typically populated with expressions that must apply to all queries sent from a specific search interface (e.g., from a specific…
RestFacetValueNumericalRange
Timezone
stringnull
The [tz database](https://en.wikipedia.org/wiki/Listoftzdatabasetimezones) identifier of the time zone to use to correctly interpret dates in the query express…
RestQueryFunction
object
4 properties
2 required
RestFacetSearchResultValue
object
3 properties
3 required
RestAutomaticFacetScope
object
To determine which fields are relevant for the current query, we consider all facet and multi-value facet fields that have the parameter "automaticFacetsCandid…
2 properties
Format
stringnull
The format of a successful response. - Use json to get the response in the JSON format. - Use xlsx to generate an Excel file containing the results (binary). N…
RestFacetRequestSpecificBase
object
7 properties
RestRankingFunction
object
3 properties
1 required
RestTokenResponse
object
1 property
ListFieldValuesValuesResponse
object
3 properties
3 required
IndexToken
stringnull
The Base64 encoded identifier of the index mirror to forward the request to. See also the index parameter. If you do not specify an indexToken (or index) value…
Recommendation
stringnull
The identifier of the recommendation interface from which the request originates (see [CoveoRecommendation](https://coveo.github.io/search-ui/components/recomm…
ActionsHistory
arraynull
The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contex…
RestFacetValueHierarchicalBase
object
4 properties
1 required
Context
objectnull
The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is eit…
RestRangeValue
object
4 properties
2 required
RestHierarchicalFacetResponseValue
object
8 properties
4 required
RestFacetRequestSpecificSortCriteriaExplicitAlphanumericNatural
object
2 properties
1 required
AnalyticsRequestParameters
objectnull
14 properties
RestFacetRequestSpecificSortCriteria
LogicalIndex
stringnull
The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a logicalIndex value,…
RestFacetRequestDateRangeBase
object
2 properties
1 required
RestTriggerResponse
object
2 properties
2 required
RestCommerceParameters
object
3 properties
RestUserId
object
6 properties
6 required
RestFacetRequestHierarchicalBase
object
7 properties
1 required
RestGroupByResult
object
5 properties
3 required
RestFacetRequestSpecificSortCriteriaString
string
The sort criterion to apply to the returned facet values. Allowed values: - score: Sort values in descending score order. Facet value scores are based on the n…
RestCategoryFacetRequest
object
6 properties
1 required
RestFacetValueDateRangeBase
object
2 properties
2 required
RestContentId
object
2 properties
2 required
PlanSearchResponse
object
2 properties
1 required
RestQueryParametersBase
object
49 properties
RestFacetValueSpecificBase
object
1 property
1 required
ParsedQueryResponse
object
6 properties
Language
stringnull
This parameter is exposed for backward compatibility reasons. Use the locale parameter instead.
RestFacetValueRangeBase
object
1 property
RestAllowedDictionaryFieldKeys
object
The [dictionary field](https://docs.coveo.com/en/2036/) keys to allow access to when authenticating a query with this search token. This value controls which f…
RestSuggestedFacet
object
2 properties
2 required
RestFacetRequestRangeBase
object
4 properties
MlParameters
objectnull
A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters: - considerUserContext (boolean): Whe…
ActionHistory
object
3 properties
RestCategoryFacetValue
array
LQ
string
The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo…
RestFacetOptions
objectnull
2 properties
RestFacetRequestHierarchical
RestHighlightResponse
object
2 properties
2 required
RestQuerySuggestParametersBase
object
4 properties
RestFacetRequestSpecificSortCriteriaExplicitOccurences
object
1 property
1 required
Referrer
stringnull
The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScr…
VisitorId
stringnull
A GUID which represents the current user, who can either be authenticated or anonymous. visitorId is deprecated and has been replaced by [clientId](https://doc…
Q
string
The basic query expression, typically the keywords entered by the end user in a query box. Note: When logging a Search usage analytics event for a query, the q…
MaximumAge
integernull
The maximum age of cached results, in milliseconds. If the results of a specific request are available in the cache, and if those results are no older than the…
RestGroupBy
object
17 properties
1 required
RestWordCorrection
object
4 properties
4 required
IndexType
stringnull
The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: co…
RestQueryResult
object
37 properties
29 required
QuerySuggestResponse
object
3 properties
2 required
ListFieldValuesBatchResponse
object
1 property
1 required
RestFacetRequestSpecificSortCriteriaExplicitCustomSort
object
The customSort sortCriteria has been deprecated. You should leverage the customSort attribute of the facet request.
2 properties
2 required
RestFacetRequestSpecificSortCriteriaExplicitScore
object
1 property
1 required
RestSuggestedFacetValue
object
2 properties
1 required
RestException
object
2 properties
1 required
Index
stringnull
The identifier of the index mirror to forward the request to. See also the indexToken parameter. If you do not specify an index (or indexToken) value, any inde…
Tab
stringnull
The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates. Co…
ListFieldsResponse
object
1 property
RestUserActionParameter
object
1 property
MaximumTimeoutMs
integernull
The maximum number of milliseconds to allow the request to last before timing out. Maximum: 10000 Minimum/Default: 0, meaning that Coveo determines the most ap…
RestListFieldValuesParameter
RestCommonQueryParameters
object
23 properties
RestFacetSearchResponse
object
2 properties
2 required
PreprocessingOutput
object
1 property
1 required
RestFacetSearchParameters
RestFacetRequestBase
object
8 properties
1 required
RestFacetRequestSpecificSortCriteriaExplicit
RestFacetValueHierarchical
RestFacetRequestDateRange
RestQueryResponse
object
29 properties
18 required
RestTokenParams
object
19 properties
1 required
ListFieldValuesResponse
object
1 property
1 required
PipelineRuleParameters
objectnull
This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic…
RestCategoryFacetResponse
object
3 properties
ErrorMessage
object
3 properties
RestFacetSearchParametersSpecific
object
9 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coveo publishes across the network.
