# Скриншот сторінки SERP API

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/screenshot`

**Tags:** DataForSEO

Повертає відрендерений скриншот сторінки результатів пошуку в Google. Повертає `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` і `items`. Відповідь обгорнуто в конверт DataForSEO: дані в `tasks[0].result`, результат у `tasks[0].status_code` — відхилений запит усе одно повертає HTTP 200.

### Довідкові ціни

- Тарифікація: вартість відповіді за даними постачальника.
- Довідкова оцінка запиту: USD 0.02.
- Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

## Related links

- [UUID](<https://en.wikipedia.org/wiki/Universally_unique_identifier>)

## 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": {
          "task_id": {
            "type": "string",
            "description": "<em>ідентифікатор завдання</em><br><strong>обов'язкове поле</strong><br>унікальний ідентифікатор пов'язаного завдання у форматі UUID<br>протягом <strong>7 днів</strong> ви зможете будь-коли запросити результати завдання"
          },
          "browser_preset": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>попередньо задана роздільна здатність браузера</em><br>необов'язкове поле<br>попередньо задане налаштування браузера, пов'язане з певним типом пристрою<br>може приймати такі значення: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Примітка:</strong> за замовчуванням попередньо задане налаштування браузера відповідає типу пристрою, указаному в POST-запиті"
          },
          "browser_screen_width": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>ширина роздільної здатності браузера</em><br>необов'язкове поле<br>можна вказати в такому діапазоні: <code>240-9999</code><br>значення за замовчуванням для <code>desktop</code>: 1920<br>значення за замовчуванням для <code>mobile</code>: 390<br>значення за замовчуванням для <code>table</code>: 1024",
            "format": "int64"
          },
          "browser_screen_height": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>висота роздільної здатності браузера</em><br>необов'язкове поле<br>можна вказати в такому діапазоні: <code>240-9999</code><br>значення за замовчуванням для <code>desktop</code>: 1080<br>значення за замовчуванням для <code>mobile</code>: 844<br>значення за замовчуванням для <code>table</code>: 1366"
          },
          "browser_screen_scale_factor": {
            "type": [
              "number",
              "null"
            ],
            "description": "<em>масштаб браузера</em><br>необов'язкове поле<br>можна вказати в такому діапазоні: <code>0.5-3</code><br>значення за замовчуванням для <code>desktop</code>: 1<br>значення за замовчуванням для <code>mobile</code>: 3<br>значення за замовчуванням для <code>table</code>: 2"
          },
          "page": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>кількість сторінок SERP</em><br>необов'язкове поле<br>якщо <code>depth</code> у відповідному POST-запиті завдання перевищує 10 результатів (або 1 сторінку SERP), укажіть кількість сторінок SERP для знімка екрана;<br>значення за замовчуванням: <code>1</code>"
          }
        },
        "example": [
          {
            "task_id": "06211235-0696-0139-1000-36727fbd3c90",
            "browser_screen_scale_factor": 0.5
          }
        ]
      }
    ]
  },
  "example": [
    {
      "task_id": "06211235-0696-0139-1000-36727fbd3c90",
      "browser_screen_scale_factor": 0.5
    }
  ]
}
```

## Responses

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

Headers:
- `X-Request-Id` (string) — Ідентифікатор запиту, який потрібно вказати під час звернення до підтримки Felo.

**application/json**

Schema: object | null

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

### 400 — Не вдалося обробити запит. Перевірте параметри запиту.

### 401 — Потрібен дійсний API-ключ Felo.

### 402 — Запит неможливо виконати: умови білінгу не виконано.

### 403 — Обліковий запис не має дозволу на цю операцію.

### 429 — Досягнуто ліміту запитів або витрат.

### 502 — Служба не змогла виконати запит.

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

### 504 — Час очікування обробки запиту вичерпано.

### default — Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

**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_ScreenshotItem

`#/components/schemas/Response36Afe1097B20_ScreenshotItem`

```json
{
  "type": "object",
  "properties": {
    "image": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>скриншот запитаної сторінки</em><br>URL скриншота сторінки у сховищі DataForSEO<br><strong>примітка: скриншот сторінки, збережений у сховищі DataForSEO, доступний лише протягом одного дня після виконання запиту</strong>"
    }
  }
}
```

### Response36Afe1097B20_SerpScreenshotResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpScreenshotResponseInfo`

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

### Response36Afe1097B20_SerpScreenshotResultInfo

`#/components/schemas/Response36Afe1097B20_SerpScreenshotResultInfo`

```json
{
  "type": "object",
  "properties": {
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>кількість елементів у масиві результатів</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_ScreenshotItem"
          }
        ]
      },
      "description": "<em>масив елементів</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpScreenshotTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpScreenshotTaskInfo`

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