Planogram Compliance

Search…
Make sure you already have configured your Authentication.
Run in postman
Nodeflux Visionaire Cloud
Nodeflux Visionaire Cloud
Request Body
Send a POST request to https://api.cloud.nodeflux.io/v1/analytics/clientname-planogram-compliance by providing these arguments as application/json.
1
{
2
    "additional_params":{
3
        "template": []
4
    },
5
    "images": [
6
        "{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
7
    ]
8
}
Copied!
Key
Type
Description
template
array
Additional parameter to manually select the template you choose.
images
array
Your .JPG or .JPEG image in base64 using data URI scheme.
Sample request
1
    "additional_params":{
2
        "template": [[1, 2, 4], [3,4,5]]
3
    },
4
    "images": [
5
        "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/
6
        2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhY
7
        aHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/"
8
    ]
9
}
Copied!
Provide only 1 image.
Please check Fundamentals -> Limits for more detail.
Response Body
HTTP Mapping: 202 Accepted
1
{
2
    "job": {
3
        "id": "a-very-long-job-id",
4
        "result": {
5
            "status": "success",
6
            "analytic_type": "CLIENTNAME_PLANOGRAM_COMPLIANCE",
7
            "sku_detection":[
8
                {
9
                    "label": "4",
10
                    "confidence": 0.99992025,
11
                    "bounding_box": {
12
                        "top": 11,
13
                        "left": 466,
14
                        "height": 80,
15
                        "width": 47
16
                    }
17
                },
18
                {
19
                    "label": "10",
20
                    "confidence": 0.9997944,
21
                    "bounding_box": {
22
                        "top": 11,
23
                        "left": 424,
24
                        "height": 80,
25
                        "width": 46
26
                    }
27
                }
28
            ],
29
            "planogram_compliance_score": 0.8181818
30
        }
31
    },
32
    "message": "Job successfully submitted!",
33
    "ok": true
34
}
Copied!
Key
Type
Description
id
string
Job ID of your request.
status
string
Status of your success, ongoing, or failed.
analytic_type
string
Type of analytic that your request.
label
string
Class type recognized by the model.
confidence
float
Confidence level of label based on the registered label.
bounding_box
dict
Bounding box coordinate in ratio of overall image size.
top is the top (y) coordinate of the bounding box. 
left is the left (x) coordinate of the bounding box. 
left is the height of the bounding box. 
width is the width of the bounding box.
planogram_compliance_score
float
Result score of planogram matching process.
License Plate Recognition
SKU Recognition
Last modified 4mo ago
Export as PDF
Copy link
Contents
Request Body
Response Body