# Обзор рангов домена

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/domain_rank_overview/live`

**Tags:** DataForSEO

Поисковое присутствие домена: количество органических и платных ключевых слов, оценка трафика и стоимость трафика по `location_code`. Возвращает `se_type`, `target`, `total_count`, `items_count` и `items`. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Те же цифры во времени — `post_dataforseo_labs_google_historical_rank_live`; сразу для многих доменов — `post_dataforseo_labs_google_bulk_traffic_estimation_live`.

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

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.0121.
- Справочный множитель для клиента: 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": {
          "target": {
            "type": "string",
            "description": "<em>домен</em><br><strong>обязательное поле</strong><br>имя домена целевого веб-сайта<br>домен указывается без <code>https://</code> и <code>www.</code>"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>полное название местоположения</em><br>необязательное поле<br>если используете это поле, <code>location_code</code> указывать не нужно<br>список доступных местоположений с <code>location_name</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>игнорируйте это поле, чтобы получить результаты для всех доступных местоположений<br>пример:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>код местоположения</em><br>необязательное поле<br>если используете это поле, <code>location_name</code> указывать не нужно<br>список доступных местоположений с <code>location_code</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>игнорируйте это поле, чтобы получить результаты для всех доступных местоположений<br>пример:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>полное название языка</em><br>необязательное поле<br>если используете это поле, <code>language_code</code> указывать не нужно<br>список доступных языков с <code>language_name</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>игнорируйте это поле, чтобы получить результаты для всех доступных языков<br>пример:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>код языка</em><br>необязательное поле<br>если используете это поле, <code>language_name</code> указывать не нужно<br>список доступных языков с <code>language_code</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>игнорируйте это поле, чтобы получить результаты для всех доступных языков<br>пример:<br><code class=\"long-string\">en</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>игнорировать очень похожие ключевые слова</em><br>необязательное поле<br>если установлено <code class=\"prettyprint\">true</code>, все очень похожие ключевые слова будут исключены из расчётов ранжирования и трафика, результаты будут основаны на данных основных ключевых слов из групп синонимов<br>значение по умолчанию: <code>false</code>"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>максимальное количество возвращаемых результатов для домена</em><br>необязательное поле<br>значение по умолчанию: <code>100</code><br>максимальное значение: <code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>смещение в массиве результатов возвращаемых элементов</em><br>необязательное поле<br>значение по умолчанию: <code>0</code><br>если указать значение <code>10</code>, первые десять <code>items</code> в массиве результатов будут пропущены, а данные будут предоставлены для последующих элементов"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "language_name": "English",
            "location_code": 2840
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "language_name": "English",
      "location_code": 2840
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

### 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_DataforseoLabsGoogleDomainRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код языка в массиве POST</em>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo"
      },
      "description": "<em>данные ранжирования, относящиеся к указанному домену</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo`

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

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>целевой домен в POST-массиве</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код языка в массиве POST</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее количество результатов в нашей базе данных, соответствующих вашему запросу</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество результатов, возвращённых в массиве <code>items</code></em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>содержит данные ранжирования и трафика</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo`

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

### Response36Afe1097B20_DataforseoLabsMetricsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #1</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #2-3</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #4-10</em>"
    },
    "pos_11_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #11-20</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #21-30</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #31-40</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #41-50</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #51-60</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #61-70</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #71-80</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #81-90</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где домен или поддомен занимает место #91-100</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>оценка объёма трафика</em><br>оценочный органический месячный трафик на домен или поддомен<br>рассчитывается как произведение значений CTR (кликабельности) и поискового объёма по всем ключевым словам категории, в которой ранжируется домен или поддомен<br>подробнее о том, как рассчитывается метрика, — в <a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее количество органических SERP, содержащих домен или поддомен</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>оценка стоимости превращения органического поискового трафика в платный</em><br>представляет оценочную месячную стоимость (USD) показа рекламы по всем ключевым словам категории, в которой ранжируется домен или поддомен<br>метрика рассчитывается как произведение органического <code>etv</code> и платного <code>cpc</code> и указывает стоимость привлечения оценочного объёма месячного органического трафика через рекламу PPC в поиске Google<br>подробнее о том, как рассчитывается метрика, — в <a href=\"https://dataforseo.com/help-center/how-is-traffic-cost-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество новых ранжированных элементов</em><br>указывает, сколько новых ранжированных элементов найдено для указанной цели"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг вырос</em><br>указывает, сколько ранжированных элементов указанной цели выросло"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг снизился</em><br>указывает, сколько ранжированных элементов указанной цели снизилось"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>потерянные ранжированные элементы</em><br>указывает, сколько ранжированных элементов указанной цели ранее присутствовали в SERP, но не были найдены при последней проверке"
    },
    "clickstream_etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>оценка объёма трафика на основе данных кликстрима</em><br>рассчитывается как произведение значений кликабельности и поискового объёма кликстрима по всем ключевым словам, для которых ранжируется домен<br>чтобы получить результаты для этого поля, параметр <code>include_clickstream_data</code> должен быть установлен в <code>true</code><br>подробнее о том, как рассчитывается метрика, — в <a href=\"https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>",
      "format": "double"
    },
    "clickstream_gender_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>распределение оценочных метрик на основе кликстрима по полу</em><br>чтобы получить результаты для этого поля, параметр <code>include_clickstream_data</code> должен быть установлен в <code>true</code><br>подробнее о том, как рассчитывается метрика, — в <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    },
    "clickstream_age_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>распределение метрик на основе кликстрима по возрасту</em><br>чтобы получить результаты для этого поля, параметр <code>include_clickstream_data</code> должен быть установлен в <code>true</code><br>подробнее о том, как рассчитывается метрика, — в <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    }
  }
}
```