latestOpenAPI 3.0.12026-08-101058136.3 KB
0fbdc2f4423a
Reports
List conversions
This 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
Each date range must include both from and to dates in ISO-8601 format (YYYY-MM-DD). 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
}
post/reports/conversions
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"
}
],
"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
}
}