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.
﻿
Return a list of visits.
GET /visits
GET
Request
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
Body Parameters
limit
Integer
optional
The number of results to return per page.
offset
Integer
optional
The initial index from which to return the results.
﻿
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».
﻿
﻿
﻿
Returns information about visit by ID.
GET /visits/{id}
GET
Request
Path Params
id
String
required
Visit ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format
﻿
﻿
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
POST /visits/{id}/ack/
POST
Request
Path Params
id
String
required
Visit ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
Body Parameters
cid
Integer
optional
Visit ID in the user system.
﻿
﻿
Change the KPI value in visit.
POST /visits/{id}/kpivalue
GET
Request
Path Params
id
String
required
Visit ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format
Body Parameters
kpi
Number
required
KPI ID.
value
Number
required
New KPI value.
target_value
Number
optional
KPI target value.
category
String
optional
KPI category.
﻿
﻿
﻿

Updated 03 Mar 2023

Did this page help you?

Tasks

Image Recognition API

Visits

﻿GET /visits

Response parameters​﻿

﻿GET /visits/{id}

﻿POST /visits/{id}/ack

﻿POST /visits/{id}/kpivalue

GET /visits

Response parameters

GET /visits/{id}

POST /visits/{id}/ack

POST /visits/{id}/kpivalue