Table Reports
This category includes the following reports:
-
Image Metric Table
-
Image Table
-
Metrics Table
And the following report templates:
-
Image Metrics Table
-
Image Table
-
Metrics Table
-
RPAS Image Metrics Table
-
RPAS Image Table
-
RPAS Metrics Table
The REST service should return a JSON object with the following properties:
Property | Type | Required | Description |
---|---|---|---|
name |
String |
Y |
The report name. |
headers |
Object |
Y |
A Table Headers Config object defining the structure of the report. |
items |
Array |
Y |
An array of Table Item objects representing the data to populate the report. |
Example response payload for Two Metric Summary:
{ "name": "Top Selling by Margin", "headers": { "image": "Image", "descriptors": ["Name", "ID"], "metrics": [{ "name": "Sales", "threshold": { "max": 700000000, "min": 10000000 }, "valueFormat": "S" }] }, "items": [ { "image": "http://my.image.url", "descriptors": ["Color Block Sundress", "10001003"], "metrics": ["854300234"] }, { "image": "", "descriptors": ["Color Item FULL ROW", "10001323"], "metrics": ["1235436234"] }, { "image": "", "descriptors": ["eqwtge", "10001323"], "metrics": ["1235436234"] } ] }