Coveo Search 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.
This API exposes
4 operations
across 4 paths,
and defines 54 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.
QueryCorrectionResponse_V2SearchProductView
object
The query correction response, if the query was corrected.
3 properties
RequestFacetBaseObject_V2SearchProductView
object
The facet operations to perform on the query. Note that this parameter is ignored in the '/productSuggest' endpoint.
6 properties
2 required
RegularValueModel_V2SearchProductView
object
The values displayed by the facet in the search interface at the moment of the request.
3 properties
1 required
Product_V2SearchProductView
object
SearchRequestModel_V2SearchProductView
object
The query suggestion request to be executed.
14 properties
6 required
HierarchicalFacetModel_V2SearchProductView
object
Hierarchical (tree-like) facet.
2 required
NumericalRangeFacetResult_V2SearchProductView
object
SortByFieldsRequestResponseModel_V2SearchProductView
object
1 required
AbstractFacetResultObject_V2SearchProductView
object
The available facets. Note that this array will always be empty in the '/productSuggest' endpoint.
6 properties
1 required
SortByRelevanceRequestResponseModel_V2SearchProductView
object
HierarchicalFacetResult_V2SearchProductView
object
DateRangeFacetResult_V2SearchProductView
object
HierarchicalFacetResultValue_V2SearchProductView
object
9 properties
NumericalRangeFacetModel_V2SearchProductView
object
Numerical range facet.
2 required
QuerySuggestRequestModel
object
The query suggestion request to be executed.
8 properties
4 required
QuerySuggestResponseModel
object
2 properties
ProductForPreview_V2SearchProductView
object
ChildProduct_V2SearchProductView
object
SortByFieldRequestResponseModel_V2SearchProductView
object
Defines the fields and, optionally, their sort order.
3 properties
1 required
RegularFacetResultValue_V2SearchProductView
object
6 properties
Completion
object
The list of query suggestions.
2 properties
ContextModel_V2SearchProductView
object
Contextual information about the query.
7 properties
1 required
HierarchicalValueModel_V2SearchProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties
1 required
RangeDomain_V2SearchProductView
object
Limits the range values to the specified domain.
3 properties
2 required
DateRangeFacetModel_V2SearchProductView
object
Date range facet.
2 required
BadgePlacementViewModel_V2SearchProductView
object
The list of badge placements associated with this product.
2 properties
SearchRedirectRequestModel_V2SearchProductView
object
The search query to be executed.
8 properties
6 required
UserModel
object
The user information.
1 property
UserModel_V2SearchProductView
object
The user information.
1 property
QueryCorrection_V2SearchProductView
object
If the query wasn't automatically corrected, this property contains the basic query expression (q) keyword corrections provided by the Did You Mean index featu…
2 properties
NumericalRangeValueModel_V2SearchProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties
2 required
SpotlightContentModel_V2SearchProductView
object
Spotlight Content
2 required
TriggerModel_V2SearchProductView
object
The actions for the client to perform based on the Trigger statements defined.
2 properties
CartItemModel_V2SearchProductView
object
A cart item.
2 properties
ContextModel
object
Contextual information about the query.
7 properties
1 required
SortResponseModel_V2SearchProductView
object
The applied and available sort options for the query.
2 properties
NumericalRangeFacetResultValue_V2SearchProductView
object
8 properties
AbstractSortRequestResponseModel_V2SearchProductView
object
Determines the order in which to retrieve the results.
1 property
WordCorrection_V2SearchProductView
object
The word correction suggestions.
4 properties
RedirectContextModel_V2SearchProductView
object
Contextual information about the query.
4 properties
1 required
RegularFacetResult_V2SearchProductView
object
SearchRedirectResponseModel_V2SearchProductView
object
1 property
DateRangeValueModel_V2SearchProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties
2 required
DateRangeFacetResultValue_V2SearchProductView
object
8 properties
PaginationResponseModel_V2SearchProductView
object
Contextual pagination information about the query.
6 properties
Result_V2SearchProductView
object
List of results including products and spotlight content
1 property
1 required
Highlight_V2SearchProductView
object
The product exerts highlights.
2 properties
ViewModel_V2SearchProductView
object
A collection of data points describing the view. Note: The term 'view' is used instead of 'page' to accommodate usage in contexts such as mobile apps.
2 properties
1 required
CartItemModel
object
A cart item.
2 properties
RegularFacetModel_V2SearchProductView
object
Regular (single string value) facet.
2 required
ViewModel
object
A collection of data points describing the view. Note: The term 'view' is used instead of 'page' to accommodate usage in contexts such as mobile apps.
2 properties
1 required
BadgeViewModel_V2SearchProductView
object
The list of badges associated with this placement
4 properties
SearchResponseModel_V2SearchProductView
object
8 properties
LegacyFacetOptions_V2SearchProductView
object
Facet Options for legacy (v1) facets.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coveo publishes across the network.
