API Reference
Start typing to search…

Query stock report data

post
https://example.com/datainsights/v1.1/stock_reports//query/data

Mode:

  • Preview: 100 Records
  • Run: 12000 Records

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

  • Filters Operators and Values
  • Columns Order
  • Group Row Modifier
  • Group Columns Modifier
  • Sort
  • Settings
Path Params
integer
required
≥ 1

Stock report id of the resource

Query Params
string
enum
Defaults to raw

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.

Allowed:
string
enum
required

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

Allowed:
Body Params
property_ids
array of integers
required
length ≥ 1

Report property ids

property_ids*
columns
array of objects
length ≥ 1

Report columns

columns
group_rows
array of objects | null

Report group rows

group_rows
group_columns
array of objects | null

Report group columns

group_columns
filters
object | null

Report filters

sort
array of objects | null

Report sort

sort
settings
object | null

Report settings

periods
array of objects | null
Defaults to null

Periods to compare

periods
custom_cdfs
array of objects | null

Report custom cdfs

custom_cdfs
formats
object | null

Formatting options of the report

comparisons
array of objects | null
Defaults to null

A list of up to 5 Comparisons, each containing 'name' and 'filters' properties. The 'filters' are the same structure as those in report.filters.

comparisons
Headers
integer
required
≥ 1

Property id of the client

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago