CLcloudbeds
Profiles

Returns the stats of a given profile.

get/profiles/{profileId}/stats

Request

  • Base URL
    /guest-profiles/v1 (relative, and the document’s source URL is not known)
  • URL
    /guest-profiles/v1/profiles/{profileId}/stats
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /oauth/token scopes: read:guest

Path parameters

profileIdnumber required
Example:226973

Profile ID

Query parameters

filterstring

Filter criteria in the format field:operation:value;field:operation:value.

  • field: The field name to filter on.
  • operation: The operation to apply (e.g., equals, not_equals, greater_than, less_than).
  • value: The value to filter by. Value is not required for some operations, like is_null. Multiple filters can be separated by semicolons (;).

Headers

X-Organization-Idstring required

Organization ID

Response

Response

profileIdstring

The guests ID.

propertyIdstring

The property ID that this statistic pertains to.

reservationsinteger

Number of reservations at this property.

nightsinteger

The number of nights at this property.

revenuenumber float

Revenue this profile has generated.

lastVisitstring date

RFC3399 date of the last time the profile visited the property (check-in date)

Changes

No recorded changes to this operation across all 1 revision of this API.