List conversions
Changed onThis endpoint returns conversion data for bookings within a specified date range.
Note: Conversions data is only provided for selected accounts based on contractual agreements.
Exactly one date filter must be provided. The available filters are:
- booking_date_range: Filter by the date the booking was made
- cancellation_date_range: Filter by the date the booking was cancelled
- checkout_date_range: Filter by the checkout date of the booking
- updated_at_range: Filter by the date the booking record last changed (e.g. status, cancellation, amounts)
Each date range must include both from and to dates in ISO-8601 format (YYYY-MM-DD). Results are ordered by the filtered date, newest first, with ties ordered by booking_reference. Results are paginated with a default page size of 100 and a maximum of 1000 records per page. Use the page_token from the response to retrieve subsequent pages.
Example requests:
Filter by booking date:
{
"booking_date_range": {
"from": "2025-01-01",
"to": "2025-01-31"
},
"page_size": 100
}
Filter by cancellation date:
{
"cancellation_date_range": {
"from": "2025-01-01",
"to": "2025-01-31"
},
"page_size": 100
}
Filter by checkout date:
{
"checkout_date_range": {
"from": "2025-01-01",
"to": "2025-01-31"
},
"page_size": 100
}
Filter by last change, e.g. to fetch updates of previously retrieved bookings:
{
"updated_at_range": {
"from": "2025-01-01",
"to": "2025-01-31"
},
"page_size": 100
}
Request
- Base URLhttps://metasearch-connect-api.booking.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"booking_date_range": {
"from": "2025-01-01",
"to": "2025-01-31"
},
"page_size": 100
}Response
OK
Example response
{
"conversions": [
{
"booking_date": "2025-01-15T14:30:00Z",
"cancellation_date": "2025-01-16T10:00:00Z",
"booking_reference": "1234567890",
"checkin_date": "2025-02-01",
"checkout_date": "2025-02-05",
"label": "campaign_xyz",
"booking_status": "confirmed",
"commission_amount": "25.50",
"commission_currency": "EUR",
"device_type": "mobile",
"property_id": 1377102,
"number_of_rooms": 1,
"number_of_guests": 2,
"room_nights": 4,
"booking_amount": "760.00",
"booking_amount_eur": "444.24",
"booking_currency": "AUD",
"updated_at": "2025-03-10T08:15:00Z"
}
],
"pagination": {
"next_page_token": "eyJwYWdlIjogMn0=",
"total_results": 150,
"total_pages": 2
},
"metadata": {
"request_id": "req_abc123xyz",
"timestamp": "2025-01-19T10:30:00Z",
"result_count": 50
}
}Changes
- breaking
removed
subschema #1subschema #2subschema #3from the request bodyoneOflist - info
added
subschema #1subschema #2subschema #3subschema #4to the request bodyoneOflist - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status
- breaking