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 get /visits return a list of visits tab request url https instance name api data v1 0 visits name request example method get request pathparameters queryparameters headerparameters kind required name authorization type string description string in token xxxxxx format bodydataparameters kind optional name limit type integer description the number of results to return per page kind optional name offset type integer description the initial index from which to return the results formdataparameters results languages id fj3zsbaijz6tuvfi40xny code n count 421 n next https test eyrene com api data v1 0 visits ?limit 30 offset 60 n previous https test eyrene com api data v1 0 visits ?limit 30 n results n n id 426 n cid n created at 2021 11 17t12 33 40 835225z n updated at 2021 11 17t12 33 40 835950z n n n id 427 n cid n created at 2021 11 17t12 33 40 072128z n updated at 2021 11 17t12 36 05 343056z n n n id 428 n cid n created at 2021 11 17t12 33 38 411075z n updated at 2021 11 17t12 33 38 412059z n n n language 200 customlabel selectedlanguageid fj3zsbaijz6tuvfi40xny examples languages id dpmodah zaotktusexn5x code curl i x get n https test eyrene com api data v1 0 visits n h authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e language curl customlabel selectedlanguageid dpmodah zaotktusexn5x description get visits currentnewparameter label body parameter value bodydataparameters response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of visits next string (uri) nullable nullable next page previous string (uri) nullable nullable previous page results array of objects an array of objects with information about manufacturers id integer visit id cid string <= 255 characters <= 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 get /visits/{id} returns information about visit by id tab examples url https instance name api data v1 0 visits id name request example method get request pathparameters kind required name id type string description visit id queryparameters headerparameters kind required name authorization type string description string in token xxxxxx format bodydataparameters formdataparameters results languages id fj3zsbaijz6tuvfi40xny code n id 324096 n cid n portal url https test eyrene com portal visit 324096 n agent id 5633 n current agent name alex n current agent route 164780 n current agent role null n store id 11020 n customer id 9e90fac2 4073 e911 811d 00505601 n is closed true n is deleted false n is new true n latitude 54 5208487 n longitude 37 0463798 n closed latitude 54 520429 n closed longitude 37 0467814 n closed at 2020 07 29t12 40 07 440127 03 00 n created at 2020 07 29t10 24 53 526334 03 00 n updated at 2020 07 30t08 07 03 598354z n app created at 2020 07 29t07 24 50 291000z n app closed at 2020 07 29t09 39 54 146000z n scenes n n id 7969 n created at 2020 07 29t07 24 55 860627z n task id 3835 n portal url https test eyrene com portal visit 324096 scene 7969 n images n image quality n clone id 0 n question groups n assortment n facing counts n n n id 8022 n created at 2020 07 29t08 49 31 907239z n task id 48 n portal url https test eyrene com portal visit 324096 scene 8022 n images n n id 26810278 n created at 2020 07 29t08 49 33 007637z n original url https storage com picture jpg n corrected perspective url https storage com picture jpg n is deleted false n annotations n shelf annotations n price annotations n n n image quality n clone id 0 n question groups n assortment n facing counts n n n id 8029 n created at 2020 07 29t09 01 16 174781z n task id 7185 n portal url https test inspector cloud com portal visit 324096 scene 8029 n images n n id 26873089 n created at 2020 07 29t09 22 38 401699z n original url https storage com picture jpg n corrected perspective url https storage com picture jpg n is deleted false n annotations n shelf annotations n price annotations n n n image quality n clone id 0 n question groups n n id 130 n questions n n id 25 n type select one n answer n 66942 promo can be done n n options n n id 66943 n value product did not arrive n n n id 66944 n value insufficient stock n n n id 66948 n value virtual stock n n n id 66945 n value product is blocked n n n id 66946 n value no promo info in store n n n id 66947 n value not in the chain matrix n n n id 66942 n value promo can be done n n n created at 2020 03 11t14 33 16 387348z n text promo status n required false n cid promo 1 n n n id 26 n type text n answer null n options n created at 2020 03 11t14 33 16 416687z n text description n required false n cid promo 5 n n n created at 2021 09 24t17 36 29 466080z n name promo n cid promo question groups n n n assortment n facing counts n n n kpi values n prices n n id 619644 n scene id 8022 n sku id 155279 n sku cid 5900020023308 n price 19 n target price null n is promo true n id competitor n updated at 2020 07 29t08 50 12 223645z n n n id 619645 n scene id 8022 n sku id 155282 n sku cid 5900020023322 n price 45 n target price null n is promo false n id competitor n updated at 2020 07 29t08 50 12 303729z n n n id 619658 n scene id 8022 n sku id 166776 n sku cid 5900020004451 n price 109 n target price null n is promo true n id competitor n updated at 2020 07 29t08 50 12 419022z n n n oos reasons n n id 7183552 n scene id 8022 n sku id 166823 n sku cid 7613036868983 n reason product is blocked n updated at 2020 07 29t09 30 14 828636z n n n id 7184629 n scene id 8022 n sku id 123878 n sku cid 4607085440583 n reason product did not arrive n updated at 2020 07 29t09 32 46 215048z n n n id 7184018 n scene id 8022 n sku id 171682 n sku cid 4600680012162 n reason recognition error n updated at 2020 07 29t09 31 20 650770z n n n dqi n n id 1979894965 n uuid 844e8e37 e4b5 4c8f 9fa8 933e3726e526 n cid dqi image perspective angle horizontal n created at 2021 09 22t13 27 05 049034z n updated at 2021 10 22t15 53 40 395212z n name perspective angle horizontal n description n related to image n severity info n threshold 0 3 n n n language 200 customlabel selectedlanguageid fj3zsbaijz6tuvfi40xny examples languages id dpmodah zaotktusexn5x code curl i x get n https test eyrene com api data v1 0 visits 324096 n h authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e language curl customlabel selectedlanguageid dpmodah zaotktusexn5x description get visits id currentnewparameter label path parameter value pathparameters post 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 tab examples url https instance name api data v1 0 visits id ack name request example method post request pathparameters kind required name id type string description visit id queryparameters headerparameters kind required name authorization type string description string in token xxxxxx format bodydataparameters kind optional name cid type integer description visit id in the user system formdataparameters results languages id fj3zsbaijz6tuvfi40xny code n details ok n language 200 customlabel selectedlanguageid fj3zsbaijz6tuvfi40xny examples languages id dpmodah zaotktusexn5x code curl i x get n https test eyrene com api data v1 0 visits 98495168681 ack n h authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e language curl customlabel selectedlanguageid dpmodah zaotktusexn5x description post visits id ack currentnewparameter label path parameter value pathparameters post post /visits/{id}/kpivalue change the kpi value in visit tab examples url https instance name api data v1 0 visits id kpivalue name request example method get request pathparameters kind required name id type string description visit id queryparameters headerparameters kind required name authorization type string description string in token xxxxxx format bodydataparameters kind required name kpi type number description kpi id kind required name value type number description new kpi value kind optional name target value type number description kpi target value kind optional name category type string description kpi category formdataparameters results languages id fj3zsbaijz6tuvfi40xny code n result visit kpi value changed n language 200 customlabel selectedlanguageid fj3zsbaijz6tuvfi40xny examples languages id dpmodah zaotktusexn5x code curl i x get n https test eyrene com api data v1 0 visits 125 n h authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e n f kpi 86 n f value 90 n f value 80 n f category tea language curl customlabel selectedlanguageid dpmodah zaotktusexn5x description post visits id kpivalue currentnewparameter label body parameter value bodydataparameters