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

GET /visits

Выводит список визитов, по которым не были получены результаты. Получение результатов по визиту подтверждается методом api/data/v1.3/visits/{🆔}/ack/

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

Content-type: application/json

Параметры тела запроса


limit integer

Количество результатов, которые возвращаются в ответе.


offset integer

Начальный индекс, с которого возвращаются результаты.


is_new boolean

Фильтр по новым визитам. По умолчанию True.


cid string

Фильтр по идентификатору визита в сторонней системе.


route string

Фильтр по идентификатору маршрута в рамках которого был выполнен визит.


agent string

Фильтр по имени агента, выполнившего визит.


datetime_gte string

Отфильтрует только те визиты, которые начались после указанной даты в формате iso 8601.


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

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

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

Код ответа: 200

{
"count": 421,
"next": "https://test.inspector-cloud.com/api/data/v1.3/visits/?limit=30&offset=60",
"previous": "https://test.inspector-cloud.com/api/data/v1.0/visits/?limit=30",
"results": [
{
"id": 426,
"cid": "",
"created_at": "2021-11-17T12:33:40.835225Z",
"updated_at": "2021-11-17T12:33:40.835950Z"
},
{
"id": 427,
"cid": "",
"created_at": "2021-11-17T12:33:40.072128Z",
"updated_at": "2021-11-17T12:36:05.343056Z"
},
{
"id": 428,
"cid": "",
"created_at": "2021-11-17T12:33:38.411075Z",
"updated_at": "2021-11-17T12:33:38.412059Z"
}
...
]
}

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


count integer

Обязательный. Количество визитов.

next string (uri) Nullable

Следующая страница списка.


previous string (uri) Nullable

Предыдущая страница списка.


results Array of objects

Обязательный. Массив объектов с информацией по визитам.

id integer

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


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

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


name string

Наименование агента.


created_at string (date-time)

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


updated_at string (date-time)

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