# Временной ряд обратных ссылок: сводка

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/backlinks/timeseries_summary/live`

**Tags:** DataForSEO

Ключевые метрики обратных ссылок одного `target` во времени, с группировкой по `group_range` (день, неделя, месяц). Возвращает `date_from`, `date_to`, `group_range` и один элемент на период. Для прироста и потерь, а не итогов, используйте `post_dataforseo_backlinks_timeseries_new_lost_live`. Здесь нет параметра limit, поэтому единственный способ сократить расходы — вызывать эндпоинт реже.

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

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.0273.
- Справочный множитель для клиента: 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>домен указывается без <code>https://</code> и <code>www.</code><br>пример:<br><code>\"forbes.com\"</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>начальная дата временного диапазона</em><br>необязательное поле<br>это поле указывает дату, которая будет использоваться как порог для сводных данных;<p>минимальное значение: <code>2019-01-30</code><br>максимальное значение не должно превышать дату, указанную в <code>date_to</code><br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2021-01-01\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>конечная дата временного диапазона</em><br>необязательное поле<br>если не указать это поле, по умолчанию будет использована сегодняшняя дата<br>минимальное значение не должно быть раньше даты, указанной в <code>date_from</code><br>максимальное значение: сегодняшняя дата<br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2021-01-15\"</code>"
          },
          "group_range": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>временной диапазон, используемый для группировки результатов</em><br>необязательное поле<br>значение по умолчанию: <code>month</code><br>возможные значения: <code>day</code>, <code>week</code>, <code>month</code>, <code>year</code><p><strong>примечание:</strong> для <code>day</code> мы вернём элементы, соответствующие всем датам между <code>date_from</code> и <code>date_to</code> включительно;<br>для <code>week</code>/<code>month</code>/<code>year</code> мы вернём элементы, соответствующие полным неделям/месяцам/годам, причём каждый элемент будет указывать на последний день недели/месяца/года<p>например, если указать:<br><code>\"group_range\": \"month\",<br>\"date_from\": \"2022-03-23\",<br>\"date_to\": \"2022-05-13\"</code><br>мы вернём элементы в промежутке с 2022-03-01 по 2022-05-31, а именно три элемента, соответствующие датам <code>2022-03-31</code>, <code>2022-04-30</code>, <code>2022-05-31</code><p>если данных для определённого <code>day</code>/<code>week</code>/<code>month</code>/<code>year</code> нет, мы вернём <code>0</code>"
          },
          "include_subdomains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>указывает, включаются ли поддомены <code>target</code> в поиск</em><br>необязательное поле<br>если задано <code>false</code>, поддомены игнорируются<br>значение по умолчанию: <code>true</code>"
          },
          "rank_scale": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>определяет шкалу, используемую для расчёта и отображения значений <code>rank</code>, <code>domain_from_rank</code> и <code>page_from_rank</code></em><br>необязательное поле<p>этот параметр позволяет выбрать, будут ли значения ранга представлены по шкале 0–100 или 0–1000<p>возможные значения:<br><code>one_hundred</code> — значения ранга отображаются по шкале 0–100<br><code>one_thousand</code> — значения ранга отображаются по шкале 0–1000<p>значение по умолчанию: <code>one_thousand</code><p>Как работает этот параметр и как рассчитываются метрики ранжирования, описано в <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">этой статье Help Center</a>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "date_from": "2021-12-01",
            "date_to": "2022-02-01",
            "group_range": "month"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "date_from": "2021-12-01",
      "date_to": "2022-02-01",
      "group_range": "month"
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveItem

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>дата и время, когда данные для target были сохранены</em><br>в формате UTC: \"yyyy-mm-dd hh-mm-ss +00:00\"<br>пример:<br><code>2019-11-15 12:57:46 +00:00</code>"
    },
    "rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг <code>target</code> на указанную <code>date</code></em><br>Подробнее о метрике и способе её расчёта — в <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    },
    "backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество обратных ссылок на указанную <code>date</code></em>",
      "format": "int64"
    },
    "backlinks_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество nofollow-обратных ссылок на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество страниц, ссылающихся на <code>target</code> на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_pages_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество ссылающихся страниц, передающих <code>target</code> хотя бы одну nofollow-ссылку на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество ссылающихся доменов на указанную <code>date</code></em><br>ссылающиеся домены включают поддомены, которые для этой метрики считаются отдельными доменами",
      "format": "int64"
    },
    "referring_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество доменов, передающих <code>target</code> хотя бы одну nofollow-ссылку на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_main_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество ссылающихся основных доменов на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_main_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество основных доменов, передающих <code>target</code> хотя бы одну nofollow-ссылку на указанную <code>date</code></em>",
      "format": "int64"
    },
    "referring_ips": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество ссылающихся IP-адресов на указанную <code>date</code></em><br>количество IP-адресов, указывающих на эту страницу",
      "format": "int64"
    },
    "referring_subnets": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество ссылающихся подсетей на указанную <code>date</code></em>",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResponseInfo`

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

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResultInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em><code>target</code> из POST-массива</em>"
    },
    "date_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>дата начала временного диапазона</em><br>в формате UTC: “yyyy-mm-dd”<br>пример:<br><code>2019-01-01</code>"
    },
    "date_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>дата окончания временного диапазона</em><br>в формате UTC: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2019-01-15\"</code>"
    },
    "group_range": {
      "type": [
        "string",
        "null"
      ],
      "description": "group_range из POST-массива"
    },
    "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_BacklinksTimeseriesSummaryLiveItem"
          }
        ]
      },
      "description": "<em>содержит релевантные сводные данные</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveTaskInfo`

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

### 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-запросе"
    }
  }
}
```