Skip to content
Wink

Show Leaderboard by Affiliate

POST
/api/analytics/leaderboard
 
curl --request POST \
  --url https://api.wink.travel/api/analytics/leaderboard \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "currencyCode": "USD", "ownerIdentifier": "" }'

Show leaderboard for a specific affiliate.

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
currencyCode
required

Display leaderboard values in this currency

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

The company you wish to track on a leaderboard

string format: uuid
"" >= 1 characters
Example 
company-1

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
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
Example generated
{
  "ownerIdentifier": "example",
  "ownerName": "example",
  "continent": "example",
  "country": "example",
  "countryGeoNameId": "example",
  "city": "example",
  "cityGeoNameId": "example",
  "bookings": 1,
  "totalPriceAmount": 1,
  "averageBookingAmount": 1,
  "currencyCode": "example"
}

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
{}