Документация
Интеграция SDK

Процедура запроса

Процедуру запроса к AppMetrica Logs API можно разделить на два этапа:

Рисунок 1. Схема процедуры запроса к Logs API

Запрос на подготовку данных

AppMetrica Logs API принимает запрос и помещает его в очередь для обработки. Если запрос обработан корректно, AppMetrica подготавливает файл для выгрузки. В этом случае API возвращает HTTP-статус 202 Accepted. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

Во время выполнения запроса и подготовки файла, все идентичные запросы (с такими же параметрами) вернут HTTP-статус 202 Accepted.

Примеры запроса:

  • HTTP-заголовок

    GET /logs/v1/export/installations.json HTTP/1.1
        Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037
  • Параметры URL

    https://api.appmetrica.yandex.ru/logs/v1/export/clicks.csv?oauth_token=05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037

Пример ответа:

HTTP/1.1 202 Accepted
    Content-Type: text/plain

    Wait for result

Чтобы получать данные в сжатом виде, необходимо в запросе передать HTTP заголовок Accept-Encoding: gzip.

Запрос на выгрузку данных

Запрос на выгрузку данных идентичен запросу на подготовку. Если запрос на подготовку файла завершен, при следующем идентичном запросе Logs API возвращает HTTP-статус 200 OK. Файл с результатом запроса готов к загрузке. Примеры формата ответов находятся в разделе Формат ответа.

Файл доступен для загрузки в течение 24 часов по URL первоначального запроса. При повторном запросе по истечении 24 часов, запрос помещается в очередь для обработки и формирования нового файла.

Вы можете вручную запросить повторную обработку запроса с помощью HTTP заголовка Cache-Control:

  • Для формирования нового файла отправить при запросе заголовок Cache-Control: no-cache.
  • Для скачивания файла, который сформирован не более чем N секунд назад, отправить при запросе заголовок Cache-Control: max-age=N. Если файл был создан более чем N секунд назад, AppMetrica формирует новый файл.
  • Для скачивания последнего сформированного файла, если он существует, не отправлять при запросе заголовок Cache-Control.