website logo
⌘K
🚀Welcome to Eyrene!
🎉What's New
😎Tutorials
📱Mobile App
💻Web Portal
🔌API
Docs powered by
Archbee
API
Data API

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 /visits
GET
Params
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
Integer
The number of results to return per page.
offset
optional
Integer
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».






GET /visits/{id}

Returns information about visit by ID.

GET /visits/{id}
GET
Params
Path Params
id
required
String
Visit ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format



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

POST /visits/{id}/ack/
POST
Params
Path Params
id
required
String
Visit ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
cid
optional
Integer
Visit ID in the user system.



POST /visits/{id}/kpivalue

Change the KPI value in visit.

POST /visits/{id}/kpivalue
GET
Params
Path Params
id
required
String
Visit ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format
Body Parameters
kpi
required
Number
KPI ID.
value
required
Number
New KPI value.
target_value
optional
Number
KPI target value.
category
optional
String
KPI category.





Updated 14 Apr 2022
Did this page help you?
PREVIOUS
Tasks
NEXT
Image Recognition API
Docs powered by
Archbee
Request example