v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Datasets

Get Dataset by id

Obtain all the CDF information related with each Dataset and the last time the dataset has been refreshed If categories is true, CDFs will be grouped by category

CDF: Cloudbeds Data field.

Dataset	Dataset Id	Description
Financial	1	Financial transactions that are made, including debits and credit and their attributes
Guest	2	The details on each guest at the hotel, including the history if their stays, their contact information, document information, etc
Reservations	3	Booking or Reservation information include who booked, where the booking came from, when it occurs, the price, the rate plans, room types, etc
Occupancy	4	The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc. Used by revenue managers to set prices and distribution strategies
Payments	5	Payment processing information, including charges, fees, chargebacks, reversals, etc.
Invoices	6	Invoices information, including reservation level information etc and credit notes.
Occupancy (Beta)	7	The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc. Used by revenue managers to set prices and distribution strategies
Housekeeping	8	...

get/datainsights/v1.1/datasets/{dataset_id}

Path parameters

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

Query parameters

cdfs'report' | 'stock_report'

Whether or not the cdfs should be from stock reports (stock) or reports (default)

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

idinteger required

Dataset id

namestring

Dataset Name

read_onlyboolean

Flag to indicate if reports can be saved in this dataset

Example response

{
  "name": "Financial",
  "cdfs": [
    {
      "category": "Booking",
      "cdfs": [
        {
          "column": "reservation_status",
          "name": "Reservation Status",
          "description": "Status of the Reservation",
          "kind": "String"
        }
      ]
    }
  ]
}