Collaborative API
Look Ahead data
Provides collaborative members' occupancy, ADR, and revenue data for a specified date range. Best intended for getting clarity on future stay dates.
POST
https://api.flip.to/v1/collaborative/report/lodging/lookahead
Query Parameters
startdate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
enddate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
type
String
Accommodation property type, valid values are:
FullServiceHotel
, SelectServiceHotel
, Condotel
, VacationRental
, RVResort
grouping
String
Defines how data is grouped and Week
is default.
Valid values are: Month
, Week
, Day
startWeekDay
String
Defines the start day of the week and Sunday
is default, valid values are:
Monday
, Tuesday
, Wednesday
, Thursday
, Friday
, Saturday
, Sunday
Example
Transactions data
Provides transactions and revenue data from all collaborative members for a specified date range.
POST
https://api.flip.to/v1/collaborative/report/lodging/bookings
Query Parameters
startdate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
enddate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
type
String
Accommodation property type, valid values are:
FullServiceHotel
, SelectServiceHotel
, Condotel
, VacationRental
, RVResort
grouping
String
Defines how data is grouped and Week
is default.
Valid values are: Month
, Week
, Day
startWeekDay
String
Defines the start day of the week and Sunday
is default, valid values are:
Monday
, Tuesday
, Wednesday
, Thursday
, Friday
, Saturday
, Sunday
Example
Sponsor referrals data
Provides transactions and revenue data attributed to the Sponsor's referral efforts for a specified date range.
POST
https://api.flip.to/v1/collaborative/report/sponsor/referrals/impact
Query Parameters
startdate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
enddate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
delay
Integer
The number of days to look back to attribute transaction to source data. Default is 15
days.
grouping
String
Defines how data is grouped and Month
is default.
Valid values are: Month
, Week
, Day
Example
Sponsor referrals data by channel
Provides transactions and revenue data attributed to the Sponsor's referral efforts for a specified channel and date range.
POST
https://api.flip.to/v1/collaborative/report/sponsor/referrals/channels/impact
Query Parameters
startdate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
enddate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
delay
Integer
The number of days to look back to attribute transaction to source data. Default is 15
days.
grouping
String
Defines how data is grouped and Month
is default.
Valid values are: Month
, Week
, Day
Example
Sponsor referrals data by geolocation
Provides transactions and revenue data attributed to the Sponsor's referral efforts for a specified geolocation and date range.
POST
https://api.flip.to/v1/collaborative/report/sponsor/referrals/geo/impact
Query Parameters
startdate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
enddate*
Date
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2023-09-18)
delay
Integer
The number of days to look back to attribute transaction to source data. Default is 15
days.
grouping
String
Defines how data is grouped and Month
is default.
Valid values are: Month
, Week
, Day
Example
Last updated