Coveo Listing Rule Preview 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 Listing Rule Preview. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.
This API exposes
3 operations
across 2 paths,
and defines 28 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.
3 operations2 paths28 schemas1 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Coveo Listing Rule Preview API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope.
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Preview the Impact of an Updated Listing Rule Vs Not Having the Rule, or If compareWithPreviousState Is True, the Impact of a Rule Update Vs the Previous State of the Rule.
Preview the Impact of Creating a Listing Rule on a Config.
previewImpactOfCreatingRule2 paramsbody→ 200
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ListingRulePreviewRequestModel_V2ProductView (15 properties), RankingRuleModel_V2ProductView (9 properties), PinRuleModel_V2ProductView (8 properties), FilterRuleModel_V2ProductView (8 properties). Each schema is shown below with its type and property counts.
RangeModel_V2ProductView
object
2 properties
StringValueModel_V2ProductView
object
1 required
DecimalValueModel_V2ProductView
object
1 required
ProductForPreview_V2ProductView
object
WordCorrection_V2ProductView
object
The word correction suggestions.
4 properties
BadgePlacementViewModel_V2ProductView
object
The list of badge placements associated with this product.
Contextual pagination information about the query.
6 properties
Result_V2ProductView
object
List of results including products and spotlight content
1 property1 required
QueryCorrection_V2ProductView
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
RuleLocaleModel_V2ProductView
object
The list of locales the rule applies to. When empty, the rule applies to all locales.
3 properties
BadgeViewModel_V2ProductView
object
The list of badges associated with this placement
4 properties
HierarchicMultiValueModel_V2ProductView
object
1 required
Product_V2ProductView
object
QueryFilterModel_V2ProductView
object
A list of filters.
3 properties2 required
ChildProduct_V2ProductView
object
RankingRuleModel_V2ProductView
object
A ranking rule.
9 properties1 required
FieldValueModel_V2ProductView
object
The value to apply the operator on.
1 property1 required
PreviewResponseIdsModel_V2ProductView
object
The unique identifiers of the API responses for a preview request.
2 properties
ListingRulePreviewRequestModel_V2ProductView
object
The rule impact preview request to be executed.
15 properties6 required
PreviewResult_V2ProductView
object
Preview result item that can be a product or spotlight content (including placeholders)
1 property1 required
FilterRuleModel_V2ProductView
object
A filter rule.
8 properties1 required
PreviewResponseModel_V2ProductView
object
6 properties
MultipleStringValuesModel_V2ProductView
object
1 required
SeedRelativeValueModel_V2ProductView
object
PinRuleModel_V2ProductView
object
A pin rule.
8 properties
QueryCorrectionResponse_V2ProductView
object
The query correction response, if the query was corrected.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Coveo Listing Rule Preview 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.
