GET /reports
Получает список всех доступных отчетов. Отчеты — это json-файлы, которые созданы для сцены на основе распознанных изображений. При необходимости для построения также используются предварительные мастер-данные, например планограммы.
Адрес: GET https://instance_name/api/v1.5/reports/
Content-type: application/json
Параметры тела запроса
limit
integer
Количество результатов, которые возвращаются в ответе.
offset
integer
Начальный индекс, с которого возвращаются результаты.
Пример запроса
curl –i –X GET
https://test.inspector-cloud.com/api/v1.5/reports/
-H ‘Authorization: Token your_token’
-F "limit=2" \
-F "offset=0"
Пример ответа
В ответе на запрос возвращается список доступных отчетов с указанием идентификаторов. Подробную информацию об отчете можно просмотреть с помощью /reports/{report_id}.
{
"count": 125455,
"next": "http://example.com",
"previous": null,
"results": [
{
"id": 1595,
"status": "READY",
"report_type": "REALOGRAM",
"created_date": "2020-07-03T15:28:08.128466Z",
"updated_date": "2020-07-03T15:28:08.128486Z",
"visit": 13
},
{
"id": 1596,
"status": "READY",
"report_type": "MUST_HAVE_SKU",
"created_date": "2020-07-03T15:28:08.189385Z",
"updated_date": "2020-07-03T15:28:08.189408Z",
"visit": 13
}
]
}
Параметры ответа
id
string
Идентификатор отчета.
status
string
Состояние отчета.
«NOT_READY» — отчет подготавливается, нужно повторить запрос позднее.
«READY» — отчет подготовлен, пользователь может использовать поле «json».
«ERROR» — при подготовке отчета возникла ошибка. Подробное описание в поле «error».
report_type
string
Тип отчета
created_date
string (date-time)
Дата создания отчета в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».
updated_date
string (date-time)
Дата обновления данных в отчете в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».
visit
string
Идентификатор визита.