Skip to main content

GET /visits

Returns a list of visits for which results not were received. Receipt of the results of the visit is confirmed by the method api/data/v1.3/visits/{🆔}/ack/

Address: GET https://instance_name/api/data/v1.3/visits/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

is_new boolean

Filter by new visits. By default True.

cid string

Filter by visit ID in the user's system.

route string

Filter by route name in visit moment.

agent string

Filter by agent name in visit moment.

datetime_gte string

Filter visits, where date is after specified date. Date use format ISO 8601.

Request example

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

Response example

Response code: 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"
    }
    ...
  ]
}

Response definitions

count integer

Required. Number of visits.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

Required. Array of objects with information about visit.

id integer

Visit ID.

cid string <= 255 characters

Visit ID in the user's system.

name string

Visit name.

created_at string (date-time)

Date and time of creation in the format «YYYY-MM-DDTHH:MM:SSZ».

updated_at string (date-time)

Date and time of data update in the format «YYYY-MM-DDTHH:MM:SSZ».