📘 Field descriptions for Botify's custom HTML extraction feature. These are project-specific fields that extract content from any element on the page using CSS selectors or XPath, configured per project.
Overview
HTML Extract fields are custom fields configured per Botify project. They let you extract content from any element on a crawled page using CSS selectors or XPath expressions. For example, pulling a product price, a publication date, a data attribute, or any other element that not captured by Botify's standard fields. The extracted values are then available for filtering, segmentation, and export alongside all other crawl data.
Datasets and API collection
Available in: SiteCrawler · RealKeywords
For API users: These fields are available in the Crawl BQL collection. HTML Extract fields follow the naming convention
extract.<field_name>, where<field_name>is defined in your project's HTML Extract configuration.
Configuration
HTML Extract fields are project-specific. The fields available in this section depend entirely on what has been configured in your project settings. To add or modify HTML Extract rules, go to your project settings and navigate to the HTML Extract section.
Extract Fields
Field name | API identifier | Kind | Type | Description |
Extract Value (example) |
| dimension | string | The value extracted from the page element targeted by this rule. The field name, selector, and type are defined in your project's HTML Extract settings. |
Note: Because HTML Extract fields are project-specific, they will not appear in projects where no extraction rules have been configured. Contact your Botify Customer Success Manager to set up HTML Extract for your project.
See also: