Skip to content
Wink

Sales overview

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/booking/overview
 
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 ”
managingEntityIdentifier
required
string
""

Show booking owned by this property

Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Grouped sales metrics for the property

Media type application/json

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
type

The dimension by which sales metrics are grouped.

string
""
Allowed values: BY_TOTAL BY_COUNTRY BY_PROPERTY
typeName

Display name of the grouping entity.

string
""
typeIdentifier

Unique identifier of the grouping entity.

string format: uuid
""
bookings

Total number of bookings in this metric set.

integer format: int64
""
totalPriceAmount

Total revenue from all bookings in the display currency.

number format: double
""
averageBookingAmount

Average booking value in the display currency.

number format: double
""
currencyCode

Currency code for the monetary amounts.

string
"" /^[A-Z]{3}$/
key
additional properties
""
Example 
{
  "type": "BY_PROPERTY",
  "typeName": "The Siam Residences, Bangkok",
  "typeIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
  "bookings": 42,
  "totalPriceAmount": 189500,
  "averageBookingAmount": 4511.9,
  "currencyCode": "THB"
}

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

404

Section titled “404 ”

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

405

Section titled “405 ”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

415

Section titled “415 ”

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example