v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Stock reports

Get stock report summary by id

get/datainsights/v1.1/stock_reports/{stock_report_id}/summary

Path parameters

stock_report_idinteger required

Stock report id of the resource

Query parameters

format'raw' | 'formatted'

Example:formatted

Select the format of the numbers in the records. The "raw" values are sent unmodified from the database. The "formatted" records as are cast to a string. Currency type CDFs are defined in the property settings and other numbers are formatted with commas to separate every third digit and a decimal to separate the fractional portion.

property_idsinteger[] required

Stock report property ids

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

totalinteger required

Total records on the report

metricsobject required

Dictionary of metric columns

Example response

{
  "total": 100
}