Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
Mozilla/5.0 (compatible; RSiteAuditor)"
},
"browser_preset": {
"type": [
"string",
"null"
],
"description": "preset for browser screen parametersbrowser_screen_width, browser_screen_height, browser_screen_scale_factor possible values:desktop, mobile, tablet
desktop preset will apply the following values:
browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1
mobile preset will apply the following values:
browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3
tablet preset will apply the following values:
browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2
Note: to use this parameter, set enable_javascript or enable_browser_rendering to true"
},
"browser_screen_width": {
"type": [
"integer",
"null"
],
"description": "browser screen width
optional field
you can set a custom browser screen width to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
minimum value, in pixels: 240
maximum value, in pixels: 9999",
"format": "int64"
},
"browser_screen_height": {
"type": [
"integer",
"null"
],
"description": "browser screen height
optional field
you can set a custom browser screen height to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
minimum value, in pixels: 240
maximum value, in pixels: 9999"
},
"browser_screen_scale_factor": {
"type": [
"number",
"null"
],
"description": "browser screen scale factor
optional field
you can set a custom browser screen resolution ratio to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
minimum value: 0.5
maximum value: 3"
},
"store_raw_html": {
"type": [
"boolean",
"null"
],
"description": "store HTML of a crawled page
optional field
set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint
default value: false"
},
"disable_cookie_popup": {
"type": [
"boolean",
"null"
],
"description": "disable the cookie popup
optional field
set to true if you want to disable the popup requesting cookie consent from the user;
default value:false"
},
"accept_language": {
"type": [
"string",
"null"
],
"description": "language header for accessing the website
optional field
all locale formats are supported (xx, xx-XX, xxx-XX, etc.)
Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array"
},
"enable_javascript": {
"type": [
"boolean",
"null"
],
"description": "load javascript on a page
optional field
set to true if you want to load the scripts available on a page
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page"
},
"enable_browser_rendering": {
"type": [
"boolean",
"null"
],
"description": "emulate browser rendering to measure Core Web Vitals
optional field
by using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;
default value: false
set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;
if you use this field, enable_javascript, and load_resources parameters must be set to true
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page"
},
"enable_xhr": {
"type": [
"boolean",
"null"
],
"description": "enable XMLHttpRequest on a page
optional field
set to true if you want our crawler to request data from a web server using the XMLHttpRequest object
default value:false
if you use this field, enable_javascript must be set to true;"
},
"switch_pool": {
"type": [
"boolean",
"null"
],
"description": "switch proxy pool
optional field
if true, additional proxy pools will be used to obtain the requested data;
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors"
},
"ip_pool_for_scan": {
"type": [
"string",
"null"
],
"description": "proxy pool
optional field
you can choose a location of the proxy pool that will be used to obtain the requested data;
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
possible values: us, de"
},
"markdown_view": {
"type": [
"boolean",
"null"
],
"description": "return page content as markdown
optional field
if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;
default value: false"
}
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api"
}
]
}
]
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api"
}
]
}
```
## Responses
### 200 — Successful operation
Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveResponseInfo"
}
]
}
```
### 400 — The request could not be processed. Check the request parameters.
### 401 — A valid Felo API key is required.
### 402 — The request cannot proceed because a billing requirement is not met.
### 403 — The account is not permitted to perform this operation.
### 429 — A request or spending limit has been reached.
### 502 — The service could not complete the request.
### 503 — The API or billing service is temporarily unavailable.
### 504 — The service timed out while processing the request.
### default — Error response; upstream passthrough responses may use provider formats
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "the current version of the API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "general informational message\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "total execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "task identifier\nunique task identifier in our system in the UUID format"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "informational message of the task\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "number of elements in the result array",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL path"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "contains the same parameters that you specified in the POST request"
}
}
}
```
### Response36Afe1097B20_Contacts
`#/components/schemas/Response36Afe1097B20_Contacts`
```json
{
"type": "object",
"properties": {
"telephones": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "array of telephone numbers
"
},
"emails": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "array of emails
"
}
}
}
```
### Response36Afe1097B20_ContentCommentInfo
`#/components/schemas/Response36Afe1097B20_ContentCommentInfo`
```json
{
"type": "object",
"properties": {
"rating": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
],
"description": "product’s rating\ncontains information about the rating a customer has given to the product"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of the customer’s comment"
},
"publish_date": {
"type": [
"string",
"null"
],
"description": "date when the comment was published"
},
"author": {
"type": [
"string",
"null"
],
"description": "author of the comment"
},
"have_form": {
"type": [
"boolean",
"null"
],
"description": ""
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "primary content on the page\nyou can find more information about content priority calculation in this help center article"
}
}
}
```
### Response36Afe1097B20_ContentOfferInfo
`#/components/schemas/Response36Afe1097B20_ContentOfferInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "name of the product"
},
"price": {
"type": [
"number",
"null"
],
"description": "price of the product",
"format": "double"
},
"price_currency": {
"type": [
"string",
"null"
],
"description": "price currency"
},
"price_valid_until": {
"type": [
"string",
"null"
],
"description": "displays the date and time until which the price is valid\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample: \"2022-11-01 10:02:52 +00:00\""
}
}
}
```
### Response36Afe1097B20_ContentParsingElement
`#/components/schemas/Response36Afe1097B20_ContentParsingElement`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "type of element"
},
"fetch_time": {
"type": [
"string",
"null"
],
"description": "date and time when the content was fethced
example:
\"2022-11-01 10:02:52 +00:00\""
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions"
},
"page_content": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageContentInfo"
}
],
"description": "parsed content of the page
"
},
"page_as_markdown": {
"type": [
"string",
"null"
],
"description": "page content in the markdown format
page content in the text-to-HTML markdown format
specify markdown_view as true in the request to return the value"
}
}
}
```
### Response36Afe1097B20_ContentUrlInfo
`#/components/schemas/Response36Afe1097B20_ContentUrlInfo`
```json
{
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
],
"description": "contains other URLs and anchors found in the content element"
},
"anchor_text": {
"type": [
"string",
"null"
],
"description": "text of the URL’s anchor"
}
}
}
```
### Response36Afe1097B20_ContententRatingInfo
`#/components/schemas/Response36Afe1097B20_ContententRatingInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "rating name\nhere you can find the following elements: Max5, Percents, CustomMax"
},
"rating_value": {
"type": [
"number",
"null"
],
"description": "the value of the rating",
"format": "double"
},
"rating_count": {
"type": [
"integer",
"null"
],
"description": "number of votes",
"format": "int64"
},
"max_rating_value": {
"type": [
"number",
"null"
],
"description": "maximum value for the rating name",
"format": "double"
},
"relative_rating": {
"type": [
"number",
"null"
],
"description": "relative rating",
"format": "double"
}
}
}
```
### Response36Afe1097B20_CrawlStatusInfo
`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`
```json
{
"type": "object",
"properties": {
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "maximum number of pages to crawl\n indicates the max_crawl_pages limit you specified when setting a task",
"format": "int64"
},
"pages_in_queue": {
"type": [
"integer",
"null"
],
"description": "number of pages that are currently in the crawling queue",
"format": "int64"
},
"pages_crawled": {
"type": [
"integer",
"null"
],
"description": "number of crawled pages",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_OnPageContentParsingLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageContentParsingLiveResultInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveResultInfo`
```json
{
"type": "object",
"properties": {
"crawl_progress": {
"type": [
"string",
"null"
],
"description": "status of the crawling session
possible values: in_progress, finished"
},
"crawl_status": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
}
],
"description": "details of the crawling session"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "number of items in the results array",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentParsingElement"
}
]
},
"description": "items array"
}
}
}
```
### Response36Afe1097B20_OnPageContentParsingLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingLiveResultInfo"
}
]
},
"description": "array of results"
}
}
}
]
}
```
### Response36Afe1097B20_PageContentInfo
`#/components/schemas/Response36Afe1097B20_PageContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "parsed content of the header
"
},
"footer": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "content of the footer of the table
"
},
"main_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "main topic on the page
you can find more information about topic priority calculation in this help center article
"
},
"secondary_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "secondary topic on the page
you can find more information about topic priority calculation in this help center article
"
},
"ratings": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
]
},
"description": "contains objects with rating information for the products displayed on the page
"
},
"offers": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentOfferInfo"
}
]
},
"description": "array of products displayed on the page
contains objects with information on products displayed on the page"
},
"comments": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentCommentInfo"
}
]
},
"description": "array of comments displayed on the page
contains objects with information on comments related to displayed products"
},
"contacts": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_Contacts"
}
],
"description": "contact information
contains contact information displayed on the page"
}
}
}
```
### Response36Afe1097B20_PageSectionContentInfo
`#/components/schemas/Response36Afe1097B20_PageSectionContentInfo`
```json
{
"type": "object",
"properties": {
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "primary content on the page
you can find more information about content priority calculation in this help center article
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "secondary content on the page
you can find more information about content priority calculation in this help center article
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "content of the table on the page
"
}
}
}
```
### Response36Afe1097B20_RowCellInfo
`#/components/schemas/Response36Afe1097B20_RowCellInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "content of the row cells of the header"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "contains other URLs and anchors found in the content element"
},
"is_header": {
"type": [
"boolean",
"null"
],
"description": "content of the row cells of the header"
}
}
}
```
### Response36Afe1097B20_SectionContentItemInfo
`#/components/schemas/Response36Afe1097B20_SectionContentItemInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "secondary content on the page\nyou can find more information about content priority calculation in this help center article"
},
"url": {
"type": [
"string",
"null"
],
"description": "page URL.\ndisplayed in case the text is a link anchor"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "contains other URLs and anchors found in the content element"
}
}
}
```
### Response36Afe1097B20_TableContentInfo
`#/components/schemas/Response36Afe1097B20_TableContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "parsed content of the header"
},
"body": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "content of the body of the table"
},
"footer": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "content of the footer of the table"
}
}
}
```
### Response36Afe1097B20_TableContentItemInfo
`#/components/schemas/Response36Afe1097B20_TableContentItemInfo`
```json
{
"type": "object",
"properties": {
"row_cells": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_RowCellInfo"
}
]
},
"description": "content of the row cells of the header"
}
}
}
```
### Response36Afe1097B20_TopicInfo
`#/components/schemas/Response36Afe1097B20_TopicInfo`
```json
{
"type": "object",
"properties": {
"h_title": {
"type": [
"string",
"null"
],
"description": "meta title
"
},
"main_title": {
"type": [
"string",
"null"
],
"description": " main title of the block
"
},
"author": {
"type": [
"string",
"null"
],
"description": "content author name
"
},
"language": {
"type": [
"string",
"null"
],
"description": "content language
"
},
"level": {
"type": [
"integer",
"null"
],
"description": "HTML level
"
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "primary content on the page
you can find more information about content priority calculation in this help center article
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "secondary content on the page
you can find more information about content priority calculation in this help center article
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "content of the table on the page
"
}
}
}
```