Create Chart
const url = 'https://api.wink.travel/api/chart';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"name":"","sort":-1,"details":""}'};
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/chart \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "name": "", "sort": -1, "details": "" }'Creates a new chart request.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
Chart name as named by creator
Example
My First ChartSort a list of charts by this sort value.
Example
1Chart settings
object
The time series to visualize
Example
HOURHow many units of the time series type to visualize. Only required if start / end date not populated.
Example
24Fixed date to start visualizations on
Example
2017-12-22T03:07:58.742+0000Fixed date to end visualizations on
Example
2017-12-23T03:07:58.742+0000Filter on hotel identifier
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on channel sub type. What channel sub-type helped make the booking.
Example
APPLICATIONFilter on seller identifier. What affiliate helped make this booking.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on customization country geoNameId. Which country is this application from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on city geoNameId. Which city is this application from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on continent. Which city is this application from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on customization. Which customization made this booking.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on country geoNameId. Which country is the traveler from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on city geoNameId. Which city is the traveler from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on continent. Which continent is the traveler from.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelFilter on user identifier. Which authenticated user made the booking.
object
The value that should be persisted.
Example
id-1English readable text of the value.
Example
Readable text labelInclude page visits
Example
falseInclude map marker visits
Example
falseInclude card visits
Example
falseInclude bookings
Example
falseInclude cancellations
Example
falseInclude room nights
Example
falseInclude meeting rooms
Example
falseInclude meeting rooms revenue
Example
falseInclude restaurants
Example
falseInclude restaurants revenue
Example
falseInclude spas
Example
falseInclude spas revenue
Example
falseInclude activities
Example
falseInclude activities revenue
Example
falseInclude attractions
Example
falseInclude attractions revenue
Example
falseInclude places
Example
falseInclude places revenue
Example
falseInclude room type ancillaries
Example
falseInclude packages revenue
Example
falseInclude add-ons
Example
falseInclude add-ons revenue
Example
falseInclude total room revenue
Example
falseInclude average room rate
Example
falseInclude combined packages and add-os revenue
Example
falseInclude total net revenue
Example
falseInclude cancelled room nights
Example
falseInclude cancelled meeting rooms
Example
falseInclude cancelled meeting rooms revenue
Example
falseInclude cancelled restaurants
Example
falseInclude cancelled restaurants revenue
Example
falseInclude cancelled spas
Example
falseInclude cancelled spas revenue
Example
falseInclude cancelled activities
Example
falseInclude cancelled activities revenue
Example
falseInclude cancelled attractions
Example
falseInclude cancelled attractions revenue
Example
falseInclude cancelled places
Example
falseInclude cancelled places revenue
Example
falseInclude cancelled packages
Example
falseInclude cancelled packages revenue
Example
falseInclude cancelled add-ons
Example
falseInclude cancelled add-ons revenue
Example
falseInclude cancelled total room revenue
Example
falseInclude combined cancelled package and add-on revenue
Example
falseInclude cancelled total net revenue
Example
falseGroup on channel sub type
Example
falseGroup on owner identifier
Example
falseGroup on application country geoNameId
Example
falseGroup on application city geoNameId
Example
falseGroup on application continent code
Example
falseGroup on customization identifier
Example
falseGroup on country geoNameId
Example
falseGroup on city geoNameId
Example
falseGroup on continent code
Example
falseGroup on hotel identifier
Example
falseGroup on user identifier
Example
falseCurrency code
Example
EURResponses
Section titled “ Responses ”Created
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
{}