Overview

The path parameter specifies which field within an article or page should be searched or evaluated. It is a required parameter for most query operators. The path parameter supports:

Note: Not all operators support all path formats (e.g., arrays or wildcards). Refer to the specific operator documentation for details.

Usage

Single field

Search for a value in a single field:

{
  "path": "heroMedia.title"
}

Nested field

Search within a nested field using dot notation:

{
  "path": "categories.id"
}

Multiple fields

Search across multiple fields:

{
  "path": ["heroMedia.title", "content.text"]
}

Wildcard matching

Wildcards can appear at any position in a path pattern, allowing flexible field matching.

Wildcard Types

The single-level wildcard * matches exactly one path segment at the wildcard position.

The multi-level wildcard ** matches zero or more path segments at the wildcard position.

Wildcard Examples

Trailing single-level: heroMedia.*

{ "path": "heroMedia.*" }

Expands to: ["heroMedia.title", "heroMedia.summary", "heroMedia.contentType", "heroMedia.sourceSystem", "heroMedia.sourceSystemId"]

Trailing multi-level: content.**

{ "path": "content.**" }

Expands to: ["content", "content.text", "content.title", "content.contentType", "content.altText", "content.id", "content.tags", "content.sourceSystem", "content.sourceSystemId", ...]

Leading single-level: *.title

{ "path": "*.title" }

Expands to: ["heroMedia.title", "content.title", "author.title"]

Leading multi-level: **.text

{ "path": "**.text" }

Expands to: ["content.text", "categories.text", "displayCategory.text", "linkedIds.text", "sponsors.text"]

Leading single-level: *.id

{ "path": "*.id" }

Expands to: ["categories.id", "displayCategory.id", "content.id"]

Leading multi-level: **.id

{ "path": "**.id" }

Expands to: ["id", "categories.id", "displayCategory.id", "content.id"]

Trailing single-level on nested: linkedIds.*

{ "path": "linkedIds.*" }

Expands to: ["linkedIds.sourceSystem", "linkedIds.sourceSystemId", "linkedIds.text"]

Trailing single-level: sponsors.*

{ "path": "sponsors.*" }

Expands to: ["sponsors.text", "sponsors.imageUrl", "sponsors.linkUrl"]

Explicit paths (no wildcards)

{ "path": ["heroMedia.title", "content.text", "author.name"] }

No expansion - uses exact paths as specified.

Performance note: Wildcards can significantly increase query cost, especially on fields with many children. Use explicit field lists when possible for better performance.

Additional wildcard examples

Search all hero media fields:

{
  "text": {
    "query": "championship",
    "path": "heroMedia.*"
  }
}

This searches across heroMedia.title, heroMedia.summary, etc.

Search all author fields:

{
  "text": {
    "query": "John Smith",
    "path": "author.*"
  }
}

This searches author.name, author.title.

Search all 'text' fields across the schema:

{
  "text": {
    "query": "Breaking News",
    "path": "**.text"
  }
}

This searches content.text, categories.text, displayCategory.text, linkedIds.text, sponsors.text.

Search all 'title' fields:

{
  "text": {
    "query": "Premier League",
    "path": "*.title"
  }
}

This searches heroMedia.title, content.title, author.title.

Search all content fields:

{
  "text": {
    "query": "video",
    "path": "content.**"
  }
}

This searches all fields under content: content.text, content.title, content.contentType, content.altText, etc.

Filter by any sourceSystem field:

{
  "equal": {
    "path": "*.sourceSystem",
    "value": "OPTA_FOOTBALL_TEAM"
  }
}

This matches heroMedia.sourceSystem, content.sourceSystem, linkedIds.sourceSystem.