Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Stock reports

Query stock report summary

Mode:

  • Preview: 100 Records
  • Run: 12000 Records

Query stock report summary from a stock report already created being able to change

  • Filters Operators and Values
  • Columns Order
  • Group Row Modifier
  • Group Columns Modifier
  • Sort
  • Settings
post/datainsights/v1.1/stock_reports/{stock_report_id}/query/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.

mode'Preview' | 'Run' required
Example:Preview

Select the mode to limit the amount of records. Preview has a limit of 100 records, and run has a limit 12,000 records

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

property_idsinteger[] required

Report property ids

Response

OK

totalinteger required

Total records on the report

metricsobject required

Dictionary of metric columns

Example response

{
  "total": 100
}