API Reference

Get stock reports based on search results

get
https://example.com/datainsights/v1.1/stock_reports/search

Get stock reports filtered by different search criteria

Notes:

  • Rows are returned if title contains values (case-insensitive comparison)
  • The API returns 200 even if no results are found.
Query Params
integer
≥ 0
Defaults to 0

The difference between start of the data and the start of the response data

integer
0 to 100
Defaults to 25

The maximum number of results in the response

string
enum
Defaults to title,asc

Sort stock_reports

ids
array of integers
length ≥ 1

Filter by Report IDs

ids
string
length between 1 and 100

Filter by Stock Report title

string | null

Filter by Report description

dataset_ids
array of integers
length ≥ 1

Dataset IDs

dataset_ids
boolean
Defaults to false

Flag to determine if response should include all cloudbeds reports, regardless of property access. Restricted by permission. Bad request exception if used with property_country_only.

boolean
Defaults to false

Flag to determine if response should only include stock reports that are specified to the property country, stock reports without a designated country will not be included. Bad request exception if used with include_cloudbeds.

folder_ids
array of integers
length ≥ 1

Filter by Folder IDs

folder_ids
string

A text string to search for in any of the search column fields

search_columns
array of strings
search_columns
boolean | null

Filter by published status

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