Show Chart
const url = 'https://api.wink.travel/api/chart/chart-1';const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};
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/chart/chart-1 \ --header 'Wink-Version: 2.0'Displays a single chart request by identifier.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Chart identifier
Example
chart-1Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”OK
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Owner of this chart
Chart name as named by creator
Sort a list of charts by this sort value.
Chart settings
object
The time series to visualize
How many units of the time series type to visualize. Only required if start / end date not populated.
Fixed date to start visualizations on
Fixed date to end visualizations on
Filter on hotel identifier
object
The value that should be persisted.
English readable text of the value.
Filter on channel sub type. What channel sub-type helped make the booking.
Filter on seller identifier. What affiliate helped make this booking.
object
The value that should be persisted.
English readable text of the value.
Filter on customization country geoNameId. Which country is this application from.
object
The value that should be persisted.
English readable text of the value.
Filter on city geoNameId. Which city is this application from.
object
The value that should be persisted.
English readable text of the value.
Filter on continent. Which city is this application from.
object
The value that should be persisted.
English readable text of the value.
Filter on customization. Which customization made this booking.
object
The value that should be persisted.
English readable text of the value.
Filter on country geoNameId. Which country is the traveler from.
object
The value that should be persisted.
English readable text of the value.
Filter on city geoNameId. Which city is the traveler from.
object
The value that should be persisted.
English readable text of the value.
Filter on continent. Which continent is the traveler from.
object
The value that should be persisted.
English readable text of the value.
Filter on user identifier. Which authenticated user made the booking.
object
The value that should be persisted.
English readable text of the value.
Include page visits
Include map marker visits
Include card visits
Include bookings
Include cancellations
Include room nights
Include meeting rooms
Include meeting rooms revenue
Include restaurants
Include restaurants revenue
Include spas
Include spas revenue
Include activities
Include activities revenue
Include attractions
Include attractions revenue
Include places
Include places revenue
Include room type ancillaries
Include packages revenue
Include add-ons
Include add-ons revenue
Include total room revenue
Include average room rate
Include combined packages and add-os revenue
Include total net revenue
Include cancelled room nights
Include cancelled meeting rooms
Include cancelled meeting rooms revenue
Include cancelled restaurants
Include cancelled restaurants revenue
Include cancelled spas
Include cancelled spas revenue
Include cancelled activities
Include cancelled activities revenue
Include cancelled attractions
Include cancelled attractions revenue
Include cancelled places
Include cancelled places revenue
Include cancelled packages
Include cancelled packages revenue
Include cancelled add-ons
Include cancelled add-ons revenue
Include cancelled total room revenue
Include combined cancelled package and add-on revenue
Include cancelled total net revenue
Group on channel sub type
Group on owner identifier
Group on application country geoNameId
Group on application city geoNameId
Group on application continent code
Group on customization identifier
Group on country geoNameId
Group on city geoNameId
Group on continent code
Group on hotel identifier
Group on user identifier
Currency code
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "ownerIdentifier": "", "name": "", "sort": -1, "details": ""}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}