Создание запроса логов

Создает запрос логов.

Примечание

Logs API не поддерживает фильтрацию на уровне запроса.

Request

POST

https://api-metrika.yandex.net/management/v1/counter/{counterId}/logrequests

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика.
Example: 2215573

Query parameters

Name

Description

date1*

Type: string

Первый день.
Example: 2016-01-01

date2*

Type: string

Последний день (не может быть текущим днем).
Example: 2016-01-31

fields*

Type: string

Список полей через запятую.
Example: ym:pv:dateTime,ym:pv:referer

source*

Type: string

Источник логов.
Источник логов. Возможные значения:

  • hits — события.
  • visits — визиты.
    Example: hits

attribution

Type: string

Модель атрибуции. Возможные значения:

  • FIRST — первый переход.
  • LAST — последний переход.
  • LASTSIGN — последний значимый переход.
  • LAST_YANDEX_DIRECT_CLICK — последний переход из Директа.
  • CROSS_DEVICE_LAST_SIGNIFICANT — последний значимый переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_FIRST — первый переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_LAST_YANDEX_DIRECT_CLICK — последний переход из Директа (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_LAST — последний переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • AUTOMATIC — автоматическая атрибуция.
    Example: FIRST

Responses

200 OK

OK

Body

application/json
{
    "log_request": {
        "request_id": 0,
        "counter_id": 0,
        "source": [
            "string"
        ],
        "date1": "string",
        "date2": "string",
        "fields": [
            "string"
        ],
        "status": "string",
        "size": 0,
        "parts": [
            {
                "part_number": 0,
                "size": 0
            }
        ],
        "attribution": "string"
    }
}

Name

Description

log_request

Type: LogRequest

Запрос логов.

LogRequest

Запрос логов.

Name

Description

attribution

Type: string

Модель атрибуции. Возможные значения:

  • FIRST — первый переход.
  • LAST — последний переход.
  • LASTSIGN — последний значимый переход.
  • LAST_YANDEX_DIRECT_CLICK — последний переход из Директа.
  • CROSS_DEVICE_LAST_SIGNIFICANT — последний значимый переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_FIRST — первый переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_LAST_YANDEX_DIRECT_CLICK — последний переход из Директа (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • CROSS_DEVICE_LAST — последний переход (кросс-девайс) с учетом визитов со всех устройств посетителя.
  • AUTOMATIC — автоматическая атрибуция.

counter_id

Type: integer<int32>

Идентификатор счётчика.

date1

Type: string

Первый день.

date2

Type: string

Последний день.

fields

Type: string[]

Список полей.

parts

Type: LogRequestPart[]

Часть ответа

request_id

Type: integer<int32>

Идентификатор запроса логов.

size

Type: integer

Размер логов запроса в байтах.

source

Type: string[]

Источник логов. Возможные значения:

  • hits — события.
  • visits — визиты.

Примечание

В параметрах визитов ym:s:&lt;attribution&gt;RecommendationSystem и ym:s:&lt;attribution&gt;Messenger могут возвращаться массивы с пропусками:

  • Если все источники просмотра неизвестны, в ответе будет [].
  • Если в массиве несколько источников, часть из которых известна, а часть — нет, в ответе они будут разделены запятыми.
  • Неизвестный источник придет в виде пустой строки. Например, [,,,telegram].

status

Type: string

Статус запроса:

  • created — создан.
  • canceled — отменён.
  • processed — обработан.
  • cleaned_by_user — очищен пользователем.
  • cleaned_automatically_as_too_old — очищен автоматически.
  • processing_failed — ошибка при обработке.
  • awaiting_retry — ожидает перезапуска.

LogRequestPart

Часть ответа

Name

Description

part_number

Type: integer<int32>

Номер части.

size

Type: integer<int64>

Размер в байтах.

No longer supported, please use an alternative and newer version.

Предыдущая
Список запросов логов
Следующая
Очистка подготовленных для загрузки логов обработанного запроса