Reports

methods allow you to get list of available reports, view information about them, and update them forcibly get get /reports retrieves a list of all available reports reports are json documents created for a scene based on recognized images and, optionally, pre loaded display master data such as a planogram the system provides a small set of basic report types in all instances, though it is not uncommon to implement custom report types based on specific client requirements these custom reports are available on specific instances only and are documented elsewhere https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/reports#response example the response to the request returns a list of available reports with the ids detailed information about the report can be viewed via /reports/{report id} https //docs eyrene com/reports#fe get reportsreportid response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/reports#response definitions id string report id status string report status not ready — the report is in the process of preparation the client must repeat the request later ready — the report was successfully prepared the client can use the "data" field error — error in the process of preparing the report the error message is available in the «error» field report type string type of report created date string (date time) date the report was created in the format "yyyy mm ddthh\ mm\ ssz" updated date string (date time) date of information update in the report in the format "yyyy mm ddthh\ mm\ ssz" visit string visit id https //help inspector cloud com/en/docs/api/backend/methods/v1 5/recognition/recognition error get get /reports/{report id} get report details by id response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report id#response definitions id string report id status string report status not ready — the report is in the process of preparation the client must repeat the request later ready — the report was successfully prepared the client can use the "data" field error — error in the process of preparing the report the error message is available in the "error" field report type string type of report for reports with the status ready ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report id#for reports with the status ready created date string (date time) date the report was created in the format "yyyy mm ddthh\ mm\ ssz" previous report string (report id) the id of the previous report with the same type, display, and customer id or null json object report data the schema depends on the report type for reports with the status error ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report id#for reports with the status error error string error message https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/reports post post /reports/force update updates report details use this method to retrospectively update reports when needed, e g when master data has changed note this method does not trigger image recognition, just reports of business logic if the webhook is specified, as soon as the reports are updated to it, a json will be sent as a post request 200 { "1786" { " " // request json object }, { " " // request json object }, { " " // request json object } } types of reports the type of the report in the response to the request is specified in the type field depending on the type of report, the contents of the json object in the response will be different facing count ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#facing count facing count report provides information on all distinct sku recognized in the scene with facing count and share of the shelf (measured as a fraction of facings) use facing count report to measure share of shelf and share of assortment kpis master data none json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example \[ { "sku id" 10, // sku id "count" 6 // number of facings }, // ] share of space ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#share of space share of space report provides information about the fraction of facing count and facing width for every recognized sku master data none json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 1 \[ { "sku id" 10, // sku id "share of count" 0 015, // number of facings / total number of facings "share of space" 0 017 // total sku facings width / total width }, // ] realogram ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#realogram realogram report provides detailed "raw" data on coordinates and size in pixels for products and shelves recognized in images of the scene in the report, the coordinates of the skus are relative to the upper left corner of the corresponding image "x", "y" are the coordinates of the center of the rectangle describing the product (bounding box) "h", "w" are height and width of this rectangle if scene images overlap, some products could be detected in several distinct images in this case, all but one corresponding annotation will have the "duplicate" field set to "true" shelf annotation specifies the start (x1, y1) and end coordinates master data none json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 2 \[ { "image" 156673, // image upload id, see uploads endpoint "annotations" \[ // list of sku object found in the image { "sku id" 232, // sku id, see sku endpoint "x" 569, // bounding box center x "y" 312, // bounding box center y "h" 112, // bounding box height "w" 112 // bounding box width "duplicate" false }, "shelf annotations" \[ // list of shelf object found in the image "x1" 45, // x1, y1 shelf start in px "y1" 63, "x2" 46, // x2, y2 shelf end in px "y2" 89 ] // other products in the image here ] }, // other images in the scene here ] price tags ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#price tags provides a relation between sku and prices as determined based on recognized price tags master data none json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 3 \[ { "sku id" 28, // sku id "price" 130 57, // sku price "price tag colors" \["yellow", "white"] // primary sku price tag colors }, ] mhl compliance ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#mhl compliance compares assortment of sku recognized in the scene with a pre defined must have list master data must have list (mhl) json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 4 { "mhl id" 16752, // must have list id "compliance" 93 5, // mhl compliance in % "records" \[ { "mhl record id" 70, // must have list record id "compliant" false // true if sku was recognized in the scene, false otherwise }, // ] } planogram compliance ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#planogram compliance provides detailed planogram compliance status and the list of actions required aggregated planogram compliance is measured as a fraction of correctly placed faces master data planogram json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 5 { "planogram id" 13249, // planogram id, see planograms endpoint "compliance" 70 4, // planogram compliance in % "images" \[ { "image id" 7877, "actions" \[ // how to fix the compliance { "x" 569, // bounding box center x not available for the action add "y" 312, // bounding box center y not available for the action add "h" 112, // bounding box height not available for the action add "w" 112, // bounding box width not available for the action add "shelf index" 2, // shelf id (top to bottom starting from 0) "rack index" 1, // rack id (left to right starting from 0) "product index" 7, // shelf position (left to right starting from 0) "sku id" 77, // sku id as recognized in the image "action type" "add", // add, delete or replace "planogram sku id" 76, // optional specified if sku action=replace // sku id as found in the planogram // human readable prescription prescription language depends on instance settings "text" "replace acme cola 2000 ml with acme orange 2000 ml" }, {"id" 2 // }, ] } // ] }provides detailed planogram compliance status and the list of actions required aggregated planogram compliance is measured as a fraction of correctly placed faces panorama ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#panorama provides panoramic images stitched from the images of the scene note that it is not guaranteed that the whole scene will be stitched to the single panorama, therefore the report format provides a list of stitched images master data none json example ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/report types#json example 6 { "rendered" \[ // a single image was stitched for this scene { "id" 156673, "url" "https /test inspector cloud com/media/ c118916f 36b5 4801 8910 c9fc1e575e33 jpg ", "width" 7200, "height" 12800, } ] }