# Микроданные OnPage API

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/microdata`

**Tags:** DataForSEO

Проверяет структурированные данные на одном обойдённом `url`. Читает завершённый обход, поэтому нужен `id` из `post_dataforseo_on_page_submit`, и возвращает `crawl_progress` и `crawl_status` со значениями `max_crawl_pages`, `pages_in_queue` и `pages_crawled` — проверяйте их, прежде чем доверять небольшому результату: у ещё идущего обхода просто меньше данных. ⚠️ Страница должна была входить в обход: если запросить URL, которого там не было, вернётся `status_code` 40406 и `Requested page was not submitted for crawling` внутри HTTP 200. Увеличьте `max_crawl_pages` или задайте `start_url` при отправке, если нужной страницы нет. 💰 Бесплатно на стороне upstream: запрос к завершённому обходу ничего не стоит, платить нужно только за сам обход.

### Справочные цены

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.012.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "<em>ID задачи</em><br><strong>обязательное поле</strong><br>этот ID можно получить в ответе эндпоинта <a href=\"/v3/on_page/task_post/\">Task POST</a><br>пример:<br><code>\"07131248-1535-0216-1000-17384017ad04\"</code>"
          },
          "url": {
            "type": "string",
            "description": "<em>URL ресурса</em><br><strong>обязательное поле</strong><br>этот URL можно получить в ответе эндпоинта <a href=\"/v3/on_page/pages/\">Pages</a><br>пример:<br><code>https://dataforseo.com/apis</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "id": "02241700-1535-0216-0000-034137259bc1",
            "url": "https://dataforseo.com/apis"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "02241700-1535-0216-0000-034137259bc1",
      "url": "https://dataforseo.com/apis"
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataResponseInfo"
    }
  ]
}
```

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "текущая версия API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "общий код состояния.\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks, возвращённых с ошибкой",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число элементов в массиве result",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "путь URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "содержит те же параметры, что вы указали в POST-запросе"
    }
  }
}
```

### Response36Afe1097B20_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "максимальное количество страниц для обхода\nуказывает заданный при постановке задачи лимит max_crawl_pages",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "количество страниц, которые сейчас находятся в очереди на сканирование",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "количество просканированных страниц",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_MessageInfo

`#/components/schemas/Response36Afe1097B20_MessageInfo`

```json
{
  "type": "object",
  "properties": {
    "level": {
      "type": [
        "string",
        "null"
      ],
      "description": "уровень ошибки\nможет принимать следующие значения: fatal, error, warning, info"
    },
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "сообщение, связанное с ошибкой\nсообщение с подробностями обнаруженной ошибки"
    }
  }
}
```

### Response36Afe1097B20_MicrodataFieldsInfo

`#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>имя поля</em><br>название поля данных"
    },
    "types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "список типов микроразметки"
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "значение микроразметки\nзначение микроразметки, указанное на целевой веб-странице"
    },
    "test_results": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MessageInfo"
        }
      ],
      "description": "<em>результаты проверки микроразметки</em><br>результаты проверки микроразметки подтипа, содержащие обнаруженные ошибки и связанные сообщения"
    },
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo"
          }
        ]
      },
      "description": "<em>поля микроразметки</em><br>массив объектов с полями данных, относящимися к определённому типу микроразметки"
    }
  }
}
```

### Response36Afe1097B20_MicrodataInspectionInfo

`#/components/schemas/Response36Afe1097B20_MicrodataInspectionInfo`

```json
{
  "type": "object",
  "properties": {
    "types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>родительские типы микроразметки</em><br>полный список доступных типов см. на <a href=\"https://schema.org/docs/full.html\" rel=\"noopener noreferrer\" target=\"_blank\">schema.org</a>"
    },
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo"
          }
        ]
      },
      "description": "<em>поля микроразметки</em><br>массив объектов с полями данных, относящимися к определённому типу микроразметки"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataInfoItem

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataInfoItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "inspection_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataInspectionInfo"
        }
      ],
      "description": "<em>информация о проверке микроразметки</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataResponseInfo`

```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_OnPageMicrodataTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageMicrodataResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>статус сеанса сканирования</em><br>возможные значения: <code>in_progress</code>, <code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>сведения о сеансе сканирования</em>"
    },
    "test_summary": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_TestSummary"
        }
      ],
      "description": "<em>результаты проверки микроразметки</em>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество элементов в массиве результатов</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataInfoItem"
          }
        ]
      },
      "description": "<em>массив элементов</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataTaskInfo`

```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_OnPageMicrodataResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_TestSummary

`#/components/schemas/Response36Afe1097B20_TestSummary`

```json
{
  "type": "object",
  "properties": {
    "fatal": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество фатальных ошибок микроразметки</em>"
    },
    "error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество серьёзных ошибок микроразметки</em>"
    },
    "warning": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество предупреждений микроразметки</em>"
    },
    "info": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество информационных флагов микроразметки</em>"
    }
  }
}
```