Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Stock reports

Get stock report by id

Get one stock report. Stock reports are the reports that Cloudbeds owns.

Notes

  • A stock report can not be edited, but can be copied.
  • Since a stock report doesn't belong to any property, it's mandatory to define it.
  • A copied stock report is the same as creating a new report where all the features are available.
get/datainsights/v1.1/stock_reports/{stock_report_id}

Path parameters

stock_report_idinteger required

Stock report id of the resource

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

OK

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