Browse
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/affiliate/grid';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/affiliate/grid \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullReturn a page of affiliates with their sales metrics for the given account, filtered by the supplied grid criteria.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Managing entity identifier (UUID)
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Grid state including pagination, sort and filter criteria for the affiliate sales results
Pagination, sorting, filtering, and grouping state used to query a paged result set.
object
Number of records to be skipped by the pager.
Example
0Number of records to take.
Example
10Descriptors used for sorting result set.
Descriptor that defines the sort direction and field for ordering a result set.
object
Descriptors used for sorting result set
Example
ascData set field to sort on
Example
hotel.nameExample
{ "dir": "asc", "field": "hotel.name"}Descriptors used for filtering result set
object
Whether to filter inclusively or exclusively
Example
andDescriptors used for filtering the result set
A single field-level filter criterion that specifies what to match and how to compare it.
object
Field name to filter on
Example
hotel.nameFilter operator to use on field
Example
startsWithValue to filter dataset against
Example
Happy ResMake filter comparison case insensitive. Default: Case sensitive
Example
trueExample
{ "field": "hotel.name", "operator": "startsWith", "value": "Happy Res", "ignoreCase": true}Example
{ "logic": "and", "filters": [ { "field": "hotel.name", "operator": "startsWith", "value": "Happy Res", "ignoreCase": true } ]}Descriptors to group result sets by.
Descriptor that defines how a result set should be grouped, including sort direction and optional aggregate calculations.
object
Field to group data set on
Example
createdDateGroup sort direction
Example
ascPrimitive aggregate data points
Descriptor that defines an aggregate function to apply to a specific field in a grouped result set.
object
Field to run aggregate function on
Example
hotel.bookingsAggregate function
Example
countExample
{ "field": "hotel.bookings", "aggregate": "count"}Example
{ "field": "createdDate", "dir": "asc", "aggregates": [ { "field": "hotel.bookings", "aggregate": "count" } ]}Example
{ "skip": 0, "take": 10, "sort": [ { "dir": "asc", "field": "hotel.name" } ], "filter": { "logic": "and", "filters": [ { "field": "hotel.name", "operator": "startsWith", "value": "Happy Res", "ignoreCase": true } ] }, "group": [ { "field": "createdDate", "dir": "asc", "aggregates": [ { "field": "hotel.bookings", "aggregate": "count" } ] } ]}Responses
Section titled “ Responses ”Paginated affiliates with sales metrics for the given account. Pagination metadata (total, page, size) is in the Page wrapper.
Booking sales metrics for a managing entity, enriched with company profile data including location, image, and online presence.
object
The company ID.
The company type
The company name
The company url slug
The company continent
The company country
The company country geo name ID
The company city
The company city geo name ID
The company image ID
Short description or bio of the managing entity.
Online presence of account.
object
List of all active accounts that could be used for selling or seeing a company’s reach.
The url, account name or phone number that identifies this user with the specified network.
The size of your audience.
How you would like to order your accounts.
Whether to disable this entry temporarily.
How much user or company spends on travel per year.
object
Monetary amount value
ISO 4217 currency code
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
{ "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type": "HOTEL", "ownerName": "The Siam Residences", "urlName": "the-siam-residences", "continent": "Asia", "country": "Thailand", "countryGeoNameId": "1605651", "city": "Bangkok", "cityGeoNameId": "1609350", "ownerImageId": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "description": "Luxury boutique hotel on the Chao Phraya River.", "onlinePresence": [ { "type": "INSTAGRAM", "identifier": "@siamresidences", "audiences": [ "TRAVEL" ], "audienceSize": 12500, "sort": 1, "disabled": false } ], "annualTravelSpendInDollars": { "amount": 250000, "currency": "USD" }, "bookings": 42, "totalPriceAmount": 63000, "averageBookingAmount": 1500, "currencyCode": "USD"}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