loading

Yext Crawler

The Yext Crawler helps you automatically populate your Knowledge Graph based on websites that you can crawl.

$idstring

The unique identifier for the Yext Crawler resource.

namestring Required

The display name of the crawler.

enabledboolean

Default: true

If true, the crawler will run according to its crawl schedule.

crawlScheduleenum (of string)

Default: “weekly”

Defines how often the crawler will index the website.

Must be one of:

  • “once”
  • “daily”
  • “weekly”

crawlStrategyenum (of string)

Default: “subPages”

Specifies the crawl strategy of the crawler

Must be one of:

  • “allPages”
  • “subPages”
  • “specificPages”

domainsarray of string

A list of domains or URLs to crawl, e.g. https://www.example.com

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

ignoreQueryParameterOptionenum (of string)

Default: “none”

Option for ignoring query parameters when differentiating crawled URLs

Must be one of:

  • “none”
  • “all”
  • “specificParameters”

ignoreQueryParametersListarray of string

Any query parameters specified in the list will be ignored when differentiating crawled URLs.

Each item of this array must be:

Type: string

blacklistedUrlsarray of string

Any URLs that match any regex rule in the list will be omitted from the crawl.

Each item of this array must be:

Type: string