Skip to content
Wink

Show Leaderboard by Region

POST
/api/analytics/leaderboard/list
 
curl --request POST \
  --url https://api.wink.travel/api/analytics/leaderboard/list \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "page": 0, "size": 100, "currencyCode": "USD", "type": "GLOBAL", "groupingIdentifier": "" }'

Show leaderboard based on location type such as continent.

Parameters

Section titled “ Parameters ”

Header Parameters

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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
page
required

Which page to access in the record set

integer format: int32
0
Example 
0
size
required

Number of result set to retrieve

integer format: int32
default: 100 <= 100
Example 
20
currencyCode
required

Display leaderboard values in this currency

string
default: USD >= 1 characters
Example 
USD
type
required

The type of leaderboard to display

string
default: GLOBAL
Allowed values: GLOBAL CONTINENT COUNTRY CITY
Example 
GLOBAL
groupingIdentifier

Can be continent, country.geoNameId or city.geoNameId

string
""
Example 
654321

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
totalPages
integer format: int32
totalElements
integer format: int64
size
integer format: int32
content
Array<object>
object
ownerIdentifier
string
ownerName
string
continent
string
country
string
countryGeoNameId
string
city
string
cityGeoNameId
string
bookings
integer format: int64
totalPriceAmount
number
averageBookingAmount
number
currencyCode
string
number
integer format: int32
numberOfElements
integer format: int32
sort
object
empty
boolean
unsorted
boolean
sorted
boolean
first
boolean
last
boolean
pageable
object
offset
integer format: int64
sort
object
empty
boolean
unsorted
boolean
sorted
boolean
pageSize
integer format: int32
paged
boolean
pageNumber
integer format: int32
unpaged
boolean
empty
boolean
Example generated
{
  "totalPages": 1,
  "totalElements": 1,
  "size": 1,
  "content": [
    {
      "ownerIdentifier": "example",
      "ownerName": "example",
      "continent": "example",
      "country": "example",
      "countryGeoNameId": "example",
      "city": "example",
      "cityGeoNameId": "example",
      "bookings": 1,
      "totalPriceAmount": 1,
      "averageBookingAmount": 1,
      "currencyCode": "example"
    }
  ],
  "number": 1,
  "numberOfElements": 1,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "first": true,
  "last": true,
  "pageable": {
    "offset": 1,
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": true
    },
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "unpaged": true
  },
  "empty": true
}

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}