Skip to content
AACSearch

Create an SEO rule

Creates a metatag rule for a collection's filter pages. The rule names the facet field whose values become pages (`facet_field`) and carries one template per metatag field. Templates use `#SECTION#` (collection), `#PROPERTY#` (the facet field), `#VALUE#` (the facet value), `#COUNT#` (how many documents carry the value) and `#SITE_NAME#` substitutions; an unknown placeholder is rejected rather than rendered literally onto live pages. At least one non-empty template is required.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
POST
/seo/rules

Creates a metatag rule for a collection's filter pages. The rule names the facet field whose values become pages (facet_field) and carries one template per metatag field. Templates use #SECTION# (collection), #PROPERTY# (the facet field), #VALUE# (the facet value), #COUNT# (how many documents carry the value) and #SITE_NAME# substitutions; an unknown placeholder is rejected rather than rendered literally onto live pages. At least one non-empty template is required.

Authorization

api_key_header
X-NOVA-API-KEY<token>

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/seo/rules" \  -H "Content-Type: application/json" \  -d '{    "collection": "string",    "name": "string",    "facet_field": "string"  }'
{  "id": "string",  "collection": "string",  "name": "string",  "facet_field": "string",  "active": true,  "url_template": "string",  "site_name": "string",  "templates": {    "title": "string",    "description": "string",    "h1": "string",    "text": "string"  },  "created_at": 0,  "updated_at": 0}

List SEO rules GET

Metatag rules for filter pages, newest first. Each rule renders one facet of a collection (`facet_field`) into metatags for every value of that facet. Paginated with `limit` and `offset`; `total` is the number of rules of the organization.

Get an SEO rule GET

Retrieves one metatag rule with its templates.