---
title: "GET /datainsights/v1.1/stock_reports"
method: GET
path: "/datainsights/v1.1/stock_reports"
tags: ["Stock reports"]
---

# GET /datainsights/v1.1/stock_reports

`GET /datainsights/v1.1/stock_reports`

## Query parameters

- `offset` integer
- `limit` integer
- `sort` 'id,asc' | 'id,desc' | 'title,asc' | 'title,desc' | 'description,asc' | 'description,desc' | 'dataset_id,asc' | 'dataset_id,desc' | 'updated_at,asc' | 'updated_at,desc'
- `ids` integer[]
- `title` string
- `description` string, nullable
- `dataset_ids` integer[]
- `include_cloudbeds` boolean
- `property_country_only` boolean
- `folder_ids` integer[]

## Headers

- `X-PROPERTY-ID` integer, required

## Response `200`

OK

- StockReports
  - `offset` integer — The difference between start of the data and the start of the response data
  - `limit` integer — The maximum number of results in the response
  - `total` integer — The total number of records
  - `stock_reports` StockReportPreview[]
    - `id` integer, required — Report id
    - `title` string, required — Report title
    - `description` string, nullable — Report description
    - `dataset_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9, required — Dataset id
    - `rules` StockReportRules
      - `feature_ids` string[], nullable — Stock Report Feature ids, one to many relationship to associate a stock report with all properties with any number of Feature.
      - `property_ids` integer[], nullable — Stock Report Property ids, one to many relationship to associate a stock report with any number of property ID.
      - `country_codes` string[], nullable — Stock Report Country Codes, one to many relationship to associate a stock report with any number of country codes.
      - `property_types` string[], nullable — Property Type
    - `updated_at` string — Report updated at
    - `published` boolean — Published status of the report
    - `custom_cdfs` StockReportCustomCdf[], nullable — Report custom cdfs
      - `id` integer — Report custom cdf id
      - `column` string — Report custom cdf column
      - `name` string, required — Report custom cdf name
      - `description` string, nullable — Report custom cdf description
      - `formula` CustomCdfFormula[], required
        - `kind` 'cdf' | 'separator' | 'operator' | 'operand' | 'parenthesis', required
        - `value` string, required — - If the kind is *cdf* the value must be a valid cdf. - If the kind is *separator* the supported values are any. - If the kind is *operator* the supported values are: ['+', '-', '*', '/']. - If the kind is *operand* the supported values are numbers. - If the kind is *parenthesis* the supported values are: ( or ).
        - `metric` 'sum' | 'mean' | 'max' | 'min' | 'count' | 'std' | 'var' | 'null', nullable
      - `kind` 'String' | 'Number' | 'Dynamic', required — Report custom cdf kind
      - `created_at` string — Report custom cdf created at
      - `updated_at` string — Report custom cdf updated at
      - `format` 'number' | 'currency' | 'percentage' | 'null', nullable — Custom Cdf Numeric format (valid for Number and Dynamic only)
    - `folder_id` integer, nullable, required — Folder id
    - `created_by` User
      - `id` integer
      - `name` string
      - `email` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/versions/2faa857793e8/schema)