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.

Request example

GET /visits

GET

https://instance_name/api/data/v1.0/visits/

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

limitInteger
Description
The number of results to return per page.
offsetInteger
Description
The initial index from which to return the results.

curl

curl –i –X GET
  https://test.eyrene.com/api/data/v1.0/visits/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

200

{
   "count":421,
   "next":"https://test.eyrene.com/api/data/v1.0/visits/?limit=30&offset=60",
   "previous":"https://test.eyrene.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 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.

Request example

GET /visits/{id}

GET

https://instance_name/api/data/v1.0/visits/{id}

Path Parameters

idstringrequired
Description
Visit ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format

curl

curl –i –X GET
  https://test.eyrene.com/api/data/v1.0/visits/324096/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

200

{
  "id": 324096,
  "cid": "",
  "portal_url": "https://test.eyrene.com/portal/visit/324096",
  "agent_id": 5633,
  "current_agent_name": "Alex",
  "current_agent_route": "164780",
  "current_agent_role": null,
  "store_id": 11020,
  "customer_id": "{9E90FAC2-4073-E911-811D-00505601}",
  "is_closed": true,
  "is_deleted": false,
  "is_new": true,
  "latitude": 54.5208487,
  "longitude": 37.0463798,
  "closed_latitude": 54.520429,
  "closed_longitude": 37.0467814,
  "closed_at": "2020-07-29T12:40:07.440127+03:00",
  "created_at": "2020-07-29T10:24:53.526334+03:00",
  "updated_at": "2020-07-30T08:07:03.598354Z",
  "app_created_at": "2020-07-29T07:24:50.291000Z",
  "app_closed_at": "2020-07-29T09:39:54.146000Z",
  "scenes": [
    {
      "id": 7969,
      "created_at": "2020-07-29T07:24:55.860627Z",
      "task_id": 3835,
      "portal_url": "https://test.eyrene.com/portal/visit/324096/scene/7969",
      "images": [],
      "image_quality": [],
      "clone_id": 0,
      "question_groups": [],
      "assortment": [],
      "facing_counts": []
    },
    {
      "id": 8022,
      "created_at": "2020-07-29T08:49:31.907239Z",
      "task_id": 48,
      "portal_url": "https://test.eyrene.com/portal/visit/324096/scene/8022",
      "images": [
        {
          "id": 26810278,
          "created_at": "2020-07-29T08:49:33.007637Z",
          "original_url": "https://storage.com/picture.jpg",
          "corrected_perspective_url": "https://storage.com/picture.jpg",
          "is_deleted": false,
          "annotations": [],
          "shelf_annotations": [],
          "price_annotations": []
        }
      ],
      "image_quality": [],
      "clone_id": 0,
      "question_groups": [],
      "assortment": [],
      "facing_counts": []
    },
    {
      "id": 8029,
      "created_at": "2020-07-29T09:01:16.174781Z",
      "task_id": 7185,
      "portal_url": "https://test.inspector-cloud.com/portal/visit/324096/scene/8029",
      "images": [
        {
          "id": 26873089,
          "created_at": "2020-07-29T09:22:38.401699Z",
          "original_url": "https://storage.com/picture.jpg",
          "corrected_perspective_url": "https://storage.com/picture.jpg",
          "is_deleted": false,
          "annotations": [],
          "shelf_annotations": [],
          "price_annotations": []
        }
      ],
      "image_quality": [],
      "clone_id": 0,
      "question_groups": [
        {
          "id": 130,
          "questions": [
            {
              "id": 25,
              "type": "select_one",
              "answer": {
                "66942": "Promo can be done"
              },
              "options": [
                {
                  "id": 66943,
                  "value": "Product did not arrive"
                },
                {
                  "id": 66944,
                  "value": "Insufficient stock"
                },
                {
                  "id": 66948,
                  "value": "Virtual stock"
                },
                {
                  "id": 66945,
                  "value": "Product is blocked"
                },
                {
                  "id": 66946,
                  "value": "No promo info in store"
                },
                {
                  "id": 66947,
                  "value": "Not in the chain matrix"
                },
                {
                  "id": 66942,
                  "value": "Promo can be done"
                }
              ],
              "created_at": "2020-03-11T14:33:16.387348Z",
              "text": "Promo status",
              "required": false,
              "cid": "PROMO_1"
            },
            {
              "id": 26,
              "type": "text",
              "answer": null,
              "options": [],
              "created_at": "2020-03-11T14:33:16.416687Z",
              "text": "Description",
              "required": false,
              "cid": "PROMO_5"
            }
          ],
          "created_at": "2021-09-24T17:36:29.466080Z",
          "name": "Promo",
          "cid": "PROMO_QUESTION_GROUPS"
        }
      ],
      "assortment": [],
      "facing_counts": []
    }
  ],
  "kpi_values": [],
  "prices": [
    {
      "id": 619644,
      "scene_id": 8022,
      "sku_id": 155279,
      "sku_cid": "5900020023308",
      "price": 19,
      "target_price": null,
      "is_promo": true,
      "id_competitor": "",
      "updated_at": "2020-07-29T08:50:12.223645Z"
    },
    {
      "id": 619645,
      "scene_id": 8022,
      "sku_id": 155282,
      "sku_cid": "5900020023322",
      "price": 45,
      "target_price": null,
      "is_promo": false,
      "id_competitor": "",
      "updated_at": "2020-07-29T08:50:12.303729Z"
    },
    {
      "id": 619658,
      "scene_id": 8022,
      "sku_id": 166776,
      "sku_cid": "5900020004451",
      "price": 109,
      "target_price": null,
      "is_promo": true,
      "id_competitor": "",
      "updated_at": "2020-07-29T08:50:12.419022Z"
    }
  ],
  "oos_reasons": [
    {
      "id": 7183552,
      "scene_id": 8022,
      "sku_id": 166823,
      "sku_cid": "7613036868983",
      "reason": "Product is blocked",
      "updated_at": "2020-07-29T09:30:14.828636Z"
    },
    {
      "id": 7184629,
      "scene_id": 8022,
      "sku_id": 123878,
      "sku_cid": "4607085440583",
      "reason": "Product did not arrive",
      "updated_at": "2020-07-29T09:32:46.215048Z"
    },
    {
      "id": 7184018,
      "scene_id": 8022,
      "sku_id": 171682,
      "sku_cid": "4600680012162",
      "reason": "Recognition error",
      "updated_at": "2020-07-29T09:31:20.650770Z"
    }
  ],
  "dqi": [
    {
      "id": 1979894965,
      "uuid": "844e8e37-e4b5-4c8f-9fa8-933e3726e526",
      "cid": "DQI_IMAGE_PERSPECTIVE_ANGLE_HORIZONTAL",
      "created_at": "2021-09-22T13:27:05.049034Z",
      "updated_at": "2021-10-22T15:53:40.395212Z",
      "name": "Perspective angle horizontal",
      "description": "",
      "related_to": "IMAGE",
      "severity": "INFO",
      "threshold": 0.3
    }
  ]
}

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

Request example

POST /visits/{id}/ack/

POST

https://instance_name/api/data/v1.0/visits/{id}/ack/

Path Parameters

idstringrequired
Description
Visit ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

cidInteger
Description
Visit ID in the user system.

curl

curl –i –X GET
  https://test.eyrene.com/api/data/v1.0/visits/98495168681/ack/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

200

{
   "details": "OK"
}

Change the KPI value in visit.

Request example

POST /visits/{id}/kpivalue

GET

https://instance_name/api/data/v1.0/visits/{id}/kpivalue/

Path Parameters

idstringrequired
Description
Visit ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format

Body Parameters

kpiNumberrequired
Description
KPI ID.
valueNumberrequired
Description
New KPI value.
target_valueNumber
Description
KPI target value.
categoryString
Description
KPI category.

curl

curl –i –X GET
  https://test.eyrene.com/api/data/v1.0/visits/125/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
  –F "kpi=86" \
  –F "value=90" \
  –F "value=80" \
  –F "category=tea" \

200

{
   "result": "Visit KPI value changed"
}

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