Restore the configuration before promotion
Restores the variants and traffic saved by the latest promotion and records a new revision. Rejects the request if no reversible promotion exists or the configuration has since changed. Experiment status is preserved.
Full-key operation
Restores the variants and traffic saved by the latest promotion and records a new revision. Rejects the request if no reversible promotion exists or the configuration has since changed. Experiment status is preserved.
Authorization
api_key_header Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).
In: header
Path Parameters
Experiment id
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/experiments/string/promotion/rollback"{ "name": "string", "description": "string", "collection": "string", "traffic": 0, "variants": [ { "id": "control", "name": "string", "weight": 0, "search_params": {}, "recommendation_params": { "model_id": "string", "blend": { "behavioral": 0, "vector": 0, "graph": 0 }, "k": 1 } } ], "id": "string", "status": "draft", "created_at": 0, "started_at": 0, "stopped_at": 0}Promote a winning variant POST
Locks in a winner: collapses `variants` to just `variant_id` (so every enrolled session gets it) and sets `traffic` to `1`. The experiment stays `running` — a promoted experiment keeps applying its winning params to all traffic rather than stopping.
Experiment report GET
Per-variant metrics computed from events (`ingestEvents`) whose `session_id` equals the `X-NOVA-SESSION-ID` the variant was assigned to, within the experiment's running window: searches, clicks, add-to-carts, purchases, revenue, click-through and conversion rates.