Booking summary
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/booking/overview';const options = { method: 'GET', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/booking/overview \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Returns aggregated sales metrics summarizing the affiliate company’s current booking status, including confirmed, pending, and cancelled bookings.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Affiliate/company identifier (UUID)
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”Aggregated booking overview for the affiliate company
Booking sales metrics grouped by a specific dimension (such as property or country), extending the base sales metrics with the group type, name, and identifier.
object
The dimension by which sales metrics are grouped.
Display name of the grouping entity.
Unique identifier of the grouping entity.
Total number of bookings in this metric set.
Total revenue from all bookings in the display currency.
Average booking value in the display currency.
Currency code for the monetary amounts.
Example
{ "type": "BY_PROPERTY", "typeName": "The Siam Residences, Bangkok", "typeIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "bookings": 42, "totalPriceAmount": 189500, "averageBookingAmount": 4511.9, "currencyCode": "THB"}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable