Visits
Methods allow you to get a list of visits or information on a specific visit. Also, you can confirm receipt of information about the visit and change the value of KPI in visit.
GET /visits
Return a list of visits.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
Response parameters
count integer
The number of visits.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about manufacturers.
- 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».
GET /visits/{id}
Returns information about visit by ID.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
POST /visits/{id}/ack
Confirm receipt of information about the visit. Allows to get an only new visits list.
Attention The is_new visit attribute is reset to true each time the visit is updated
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
POST /visits/{id}/kpivalue
Change the KPI value in visit.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|