Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Stock reports

Publish a new report

Publish a single report to a stock report with optional rules.

The API returns a 201 CREATED if the creation was successful.

post/datainsights/v1.1/stock_reports

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

report_idinteger required

Report Id

Example request

{
  "rules": {
    "feature_ids": [
      "1"
    ],
    "country_codes": [
      "US"
    ]
  }
}

Response

Created

idinteger required

Report id

titlestring required

Report title

descriptionstring nullable

Report description

dataset_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 required

Dataset id

type'List' | 'Summary' | 'Pivot' required

Report type

folder_idinteger nullable required

Folder id

schedule_idsinteger[] required

Report schedule ids

updated_atstring

Report updated at

property_idsinteger[]

Report property ids

user_idinteger required

User id

publishedboolean

Published status of the report