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

Name	Type	Description
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

Response

{
    "totalProperties": 32,
    "totalRooms": 9660,
    "data": [
        {
            "startDate": "2021-01-01",
            "endDate": "2021-01-31",
            "occupancy": {
                "availableBookNights": 289800,
                "bookedNights": 4008
            },
            "dailyRate": {
                "minDailyRate": 25.81,
                "maxDailyRate": 521.54,
                "avgDailyRate": 47.57
            },
            "stayLength": {
                "minStayNights": 1,
                "maxStayNights": 74,
                "avgStayNights": 2
            },
            "revenue": {
                "totalTransactions": 1719,
                "totalTransactionNights": 4585,
                "minTransactionRevenue": 48,
                "maxTransactionRevenue": 3132.03,
                "totalTransactionRevenue": 459003.23,
                "avgTransactionRevenue": 267.02
            }
        },
        …
    ]
}

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

Name	Type	Description
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

Response

{
    "totalProperties": 32,
    "totalRooms": 9660,
    "data": [
        {
            "startDate": "2020-12-27T00:00:00",
            "endDate": "2021-01-02T00:00:00",
            "revenue": {
                "totalTransactions": 934,
                "totalTransactionNights": 3290,
                "minTransactionRevenue": 49,
                "maxTransactionRevenue": 11828.92,
                "totalTransactionRevenue": 714171.46,
                "avgTransactionRevenue": 764.64
            },
            "stayLength": {
                "minStayNights": 1,
                "maxStayNights": 34,
                "avgStayNights": 3
            }
        },
        …
    ]
}

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

Name	Type	Description
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

Response

[
    {
        "year": 2023,
        "timeGrouping": 1,
        "referralTransactions": 3,
        "referralRevenue": 1500,
        "influencedTransactions": 2,
        "influencedRevenue": 1000
    },
    {
        "year": 2023,
        "timeGrouping": 2,
        "referralTransactions": 5,
        "referralRevenue": 2500,
        "influencedTransactions": 4,
        "influencedRevenue": 2000
    }
]

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

Name	Type	Description
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

Response

[
    {
        "year": 2023,
        "timeGrouping": 1,
        "source": "google",
        "medium": "search",
        "term": null,
        "referralTransactions": 3,
        "referralRevenue": 1500,
        "influencedTransactions": 2,
        "influencedRevenue": 1000
    },
    {
        "year": 2023,
        "timeGrouping": 2,
        "source": "google",
        "medium": "search",
        "term": null,
        "referralTransactions": 5,
        "referralRevenue": 2500,
        "influencedTransactions": 4,
        "influencedRevenue": 2000
    }
]

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

Name	Type	Description
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

Response

[
    {
        "year": 2023,
        "timeGrouping": 1,
        "country": "US",
        "region": "NY",
        "city": "New York",
        "referralTransactions": 3,
        "referralRevenue": 1500,
        "influencedTransactions": 2,
        "influencedRevenue": 1000
    },
    {
        "year": 2023,
        "timeGrouping": 2,
        "country": "US",
        "region": "NY",
        "city": "New York",
        "referralTransactions": 5,
        "referralRevenue": 2500,
        "influencedTransactions": 4,
        "influencedRevenue": 2000
    }
]