Перейти к основному содержимому

GET /visits/{id}

Получает информацию о визите по его индентификатору.

Адрес: GET https://instance_name/api/data/v1.3/visits/{id}/

Content-type: application/json

Параметры path


id integer

Обязательный. Уникальный идентификатор визита.

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

curl –i –X GET
https://test.inspector-cloud.com/api/data/v1.3/visits/324096/
-H ‘Authorization: Token <<your_token>>

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

Код ответа: 200

{
"id": 324096,
"cid": "",
"portal_url": "https://test.inspector-cloud.com/portal/visit/324096",
"agent_id": 5633,
"current_agent_name": "Alex",
"current_agent_route": "164780",
"current_agent_role": null,
"store_id": 11020,
"customer_id": "{9E90FAC2-4073-E911-811D-00505601}",
"is_closed": true,
"is_deleted": false,
"is_new": true,
"latitude": 54.5208487,
"longitude": 37.0463798,
"closed_latitude": 54.520429,
"closed_longitude": 37.0467814,
"closed_at": "2020-07-29T12:40:07.440127+03:00",
"created_at": "2020-07-29T10:24:53.526334+03:00",
"updated_at": "2020-07-30T08:07:03.598354Z",
"app_created_at": "2020-07-29T07:24:50.291000Z",
"app_closed_at": "2020-07-29T09:39:54.146000Z",
"scenes": [
{
"id": 7969,
"created_at": "2020-07-29T07:24:55.860627Z",
"task_id": 3835,
"portal_url": "https://test.inspector-cloud.com/portal/visit/324096/scene/7969",
"images": [],
"image_quality": [],
"clone_id": 0,
"question_groups": [],
"assortment": [],
"facing_counts": []
},
{
"id": 8022,
"created_at": "2020-07-29T08:49:31.907239Z",
"task_id": 48,
"portal_url": "https://test.inspector-cloud.com/portal/visit/324096/scene/8022",
"images": [
{
"id": 26810278,
"created_at": "2020-07-29T08:49:33.007637Z",
"original_url": "https://storage.com/picture.jpg",
"corrected_perspective_url": "https://storage.com/picture.jpg",
"is_deleted": false,
"annotations": [],
"shelf_annotations": [],
"price_annotations": []
}
],
"image_quality": [],
"clone_id": 0,
"question_groups": [],
"assortment": [],
"facing_counts": []
},
{
"id": 8029,
"created_at": "2020-07-29T09:01:16.174781Z",
"task_id": 7185,
"portal_url": "https://test.inspector-cloud.com/portal/visit/324096/scene/8029",
"images": [
{
"id": 26873089,
"created_at": "2020-07-29T09:22:38.401699Z",
"original_url": "https://storage.com/picture.jpg",
"corrected_perspective_url": "https://storage.com/picture.jpg",
"is_deleted": false,
"annotations": [],
"shelf_annotations": [],
"price_annotations": []
}
],
"image_quality": [],
"clone_id": 0,
"question_groups": [
{
"id": 130,
"questions": [
{
"id": 25,
"type": "select_one",
"answer": {
"66942": "Промо выполняется"
},
"options": [
{
"id": 66943,
"value": "Не пришел продукт"
},
{
"id": 66944,
"value": "Недостаточный сток"
},
{
"id": 66948,
"value": "Виртуальный сток"
},
{
"id": 66945,
"value": "Продукт в блоке"
},
{
"id": 66946,
"value": "Нет инфо о промо в точке"
},
{
"id": 66947,
"value": "Нет в матрице сети"
},
{
"id": 66942,
"value": "Промо выполняется"
}
],
"created_at": "2020-03-11T14:33:16.387348Z",
"text": "Статус выполнения промо",
"required": false,
"cid": "PROMO_1"
},
{
"id": 26,
"type": "text",
"answer": null,
"options": [],
"created_at": "2020-03-11T14:33:16.416687Z",
"text": "Комментарий",
"required": false,
"cid": "PROMO_5"
}
],
"created_at": "2021-09-24T17:36:29.466080Z",
"name": "Промо",
"cid": "PROMO_QUESTION_GROUPS"
}
],
"assortment": [],
"facing_counts": []
}
],
"kpi_values": [],
"prices": [
{
"id": 619644,
"scene_id": 8022,
"sku_id": 155279,
"sku_cid": "5900020023308",
"price": 19,
"target_price": null,
"is_promo": true,
"id_competitor": "",
"updated_at": "2020-07-29T08:50:12.223645Z"
},
{
"id": 619645,
"scene_id": 8022,
"sku_id": 155282,
"sku_cid": "5900020023322",
"price": 45,
"target_price": null,
"is_promo": false,
"id_competitor": "",
"updated_at": "2020-07-29T08:50:12.303729Z"
},
{
"id": 619658,
"scene_id": 8022,
"sku_id": 166776,
"sku_cid": "5900020004451",
"price": 109,
"target_price": null,
"is_promo": true,
"id_competitor": "",
"updated_at": "2020-07-29T08:50:12.419022Z"
}
],
"oos_reasons": [
{
"id": 7183552,
"scene_id": 8022,
"sku_id": 166823,
"sku_cid": "7613036868983",
"reason": "Продукт в блоке",
"updated_at": "2020-07-29T09:30:14.828636Z"
},
{
"id": 7184629,
"scene_id": 8022,
"sku_id": 123878,
"sku_cid": "4607085440583",
"reason": "Не пришел продукт",
"updated_at": "2020-07-29T09:32:46.215048Z"
},
{
"id": 7184018,
"scene_id": 8022,
"sku_id": 171682,
"sku_cid": "4600680012162",
"reason": "Ошибка распознавания",
"updated_at": "2020-07-29T09:31:20.650770Z"
}
],
"dqi": [
{
"id": 1979894965,
"uuid": "844e8e37-e4b5-4c8f-9fa8-933e3726e526",
"cid": "DQI_IMAGE_PERSPECTIVE_ANGLE_HORIZONTAL",
"created_at": "2021-09-22T13:27:05.049034Z",
"updated_at": "2021-10-22T15:53:40.395212Z",
"name": "Горизонтальная перспектива",
"description": "",
"related_to": "IMAGE",
"severity": "INFO",
"threshold": 0.3
}
]
}

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


id integer

Идентификатор визита.


cid string <= 255 символов

Идентификатор визита в сторонней системе.


portal_url string

Ссылка на портале.


agent_id string

Идентификатор агента, выполняющего визит.


current_agent_name string <= 255 символов

Наименование текущего агента.


current_agent_route string <= 255 символов Nullable

Маршрут текущего агента.


current_agent_role string

Роль текущего агента.


store_id integer

Идентификатор магазина.


customer_id string non-empty Nullable

Идентификатор клиента.


is_closed boolean

Признак, закрыт ли визит. True, если визит закрыт.


is_deleted boolean

Признак, удален ли визит. True, если визит удален.


is_new boolean

Признак, новый ли визит. True, если визит новый.


latitude number Nullable

Координата широты во время начала визита.


longitude number Nullable

Координата долготы во время начала визита.


closed_latitude number Nullable

Координата широты во время закрытия визита.


closed_longitude number Nullable

Координата долготы во время закрытия визита.


closed_at string (date-time)

Обязательный.Дата закрытия визита в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».

created_at string (date-time)

Обязательный.Дата создания визита в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».

updated_at string (date-time)

Дата обновления визита в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


app_created_at string (date-time) Nullable

Дата создания визита в приложении в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


app_closed_at string (date-time) Nullable

Дата закрытия визита в приложении в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


scenes Array of objects

Массив с информацией о сценах в визите.

id integer

Идентификатор сцены в визите.


created_at string (date-time)

Дата и время создания сцены в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


task_id integer

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


portal_url string

Ссылка на сцену на портале.


images string

Изображения в сцене.


image_quality object

Информация о данных с изображения.

id integer

Обязательный.

sharpness integer

Обязательный.

perspective_angles integer

Обязательный.

shelfs_count integer non-empty

Обязательный.

facing_count integer

Обязательный.

clone_id integer [ -2147483648 .. 2147483647 ] Nullable

Идентификатор копии изображения.


question_groups object

Просмотреть вложенные объекты

id integer


questions object

Просмотреть вложенные объекты

id integer


type string non-empty


answer string non-empty


options Array of objects

Обязательный. Параметры вопроса.

id integer


value string Nullable`



created_at string (date-time)


text string Nullable


required boolean


cid string <= 255 characters Nullable



created_at string (date-time)


name string <= 255 символов Nullable


cid string <= 255 символов Nullable



assortment object

Просмотреть вложенные объекты

sku_id string


sku_cid string


quantity integer


status string



facing_counts object

Просмотреть вложенные объекты

sku_id integer

Обязательный.

sku_cid string


FG integer non-empty

Обязательный.


kpi_values Array of objects

Массив с информацией о показателях в визите.

id integer


kpi_id string


kpi_cid string non-empty


updated_at string (date-time)


category string <= 255 символов Nullable


value number

Обязательный. Значение показателя.

target_value string Nullable

Целевое значение показателя.


details object

Обязательный.

exclude_from_reports boolean


exclude_from_reports_comment string <= 255 символов Nullable


clone_id string [ -2147483648 .. 2147483647 ]



prices Array of objects

Массив с информацией о ценниках в визите.

id integer


scene_id string


sku_id string


sku_cid string non-empty


price number Nullable


target_price number Nullable


is_promo boolean Nullable


id_competitor string


updated_at string (date-time)



oos_reasons Array of objects

Массив с информацией о причинах OOS для товаров в визите.

id integer


scene_id string


sku_id string


sku_cid string non-empty


reason string Nullable


updated_at string (date-time)


diagnosis string Итог обработки факта OOS внутренними правилами проекта


fixed bollean Был ли учтён SKU как найденный по итогу фотопрува



dqi Array of objects

Массив с информацией о DQI. доступен с версии 1.1 и выше

id integer (bigint)

Идентификатор показателя DQI.


type integer (bigint)

Тип DQI.


created_at string (date-time)

Дата и время создания DQI в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


updated_at string (date-time)

Дата и время обновления DQI в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».


visit_id integer (bigint) Nullable

Идентификатор визита.


scene_id integer (bigint) Nullable

Идентификатор сцены.


image_id integer (bigint) Nullable

Идентификатор изображения.


severity string

Строгость показателя.


threshold float

Обязательный. Порог, ниже или выше которого не должен опускаться показатель DQI.

value float

Обязательный. Значение показателя в сцене, фото или визите.

json json

Дополнительная информация по DQI. Определяется внутренними правилами проекта.