Sales overview
const url = 'https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/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/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/booking/overview \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Returns grouped sales metrics summarising the property’s bookings for dashboard display.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Show booking owned by this property
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Grouped sales metrics for the property
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
Average booking value in the display currency.
Total number of bookings in this metric set.
Currency code for the monetary amounts.
Total revenue from all bookings in the display currency.
The dimension by which sales metrics are grouped.
Unique identifier of the grouping entity.
Display name of the grouping entity.
Example
{ "averageBookingAmount": 4511.9, "bookings": 42, "currencyCode": "THB", "totalPriceAmount": 189500, "type": "BY_PROPERTY", "typeIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "typeName": "The Siam Residences, Bangkok"}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
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
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