Проверка состояния запроса

Проверьте состояние запроса на экспорт сегмента.

Входные данные

End-point

https://tracker.my.com/api/segment/v1/export/get.json

Метод

GET

Параметры

Название Значение Описание
idSegmentExport * Целое число Уникальный идентификатор выгрузки

* — обязательные параметры

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

/api/segment/v1/export/get.json?idSegmentExport=1

Форматы ответа

В случае успеха

Если запрос принят и обработан корректно, вы получите код ответа 200. Формат ответа будет зависеть от статуса выгрузки:

  • Если выгрузка в процессе, то в ответе будут указаны процент выполнения выгрузки progress:

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idSegmentExport": "1",
        "status": "In progress",
        "progress": "64%",
      }
    }
  • Если в процессе выгрузки произошла ошибка и можно повторить запрос:

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idSegmentExport": "1",
        "status": "Error occurred"
      }
    }
  • Если файлы с выгрузкой успешно созданы, то ответ будет содержать ссылки для скачивания. Для каждой ссылки указана временная метка timestamp — до этого времени файл будет доступен для скачивания.

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idSegmentExport": "1",
        "status": "Success!",
        "files": [
          {
            "link": "https://rawdata.hb.bizmrg.com/segment/2021.03.30/1.1.c3217d0d061c695550c9cf8a8fa72520.csv.gz",
            "timestampExpires": "1617197992"
          },
          {
            "link": "https://rawdata.hb.bizmrg.com/segment/2021.03.30/1.1.c695fa72610d0cf8a550c9520217dc38.csv.gz",
            "timestampExpires": "1617197992"
          }
        ]
      }
    }

Ошибки

Обращение к несуществующей выгрузке или к выгрузке, к которой у вас нет доступа, вызовет 404 ошибку:

{
  "code": 404,
  "message": "Not Found",
  "data": {
    "error": {
      "detail": "Segment export request not found"
    }
  }
}

Ограничения

Данный метод требует авторизации. Вы получите код ответа 403, если сделаете запрос с невалидной авторизацией или не передадите её совсем.

{
  "code": 403,
  "message": "Access denied",
  "data": null
}