Skip to content
Wink

Affiliate Booking Analytics

POST
/api/managing-entity/{managingEntityIdentifier}/studio/booking/analytics
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/company-1/studio/booking/analytics \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "type": "HOUR", "units": "" }'

Retrieve the number of upcoming bookings that arrive today for the specific company.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Show active booking count for company with this identifier

Example 
company-1

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 ”

Overview request body

Media type application/json
object
type
required

The type of time series that should be used

string
""
Allowed values: HOUR DAY MONTH YEAR
Example 
MONTH
units

How many units of the timeseries type should be used

integer format: int64
""
Example 
12

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
charts
required

Interesting property-level chart data overview

Array<object>
""
object
identifier

Unique line chart identifier

string format: uuid
""
title

The configuration options for the chart title

object
text
string
legend

The configuration options for the chart legend.

object
data
Array<string>
series

The configuration of the chart series. The series type is determined by the value of the type field. If a type value is missing, the chart renders the type that is specified in seriesDefaults. Some options accept functions as arguments. These arguments are evaluated for each point which is supplied as a parameter. If no value is returned, the chart uses the theme or seriesDefaults values.

Array<object>
""
object
name

The name of the Chart series which is visible in the legend.

string
""
data

The array of data items which represent the series data.

You can set it to:

  • Array of numbers. Supported when the series.type option is set to area, bar, column, donut, pie, line, or waterfall. The Bubble series need arrays of three values—X value, Y value, and Size value—for example, [1, 1, 10]. The Scatter and ScatterLine series need arrays of two values—X value and Y value. The OHLC and Candlestick series need arrays of four values—open, high, low, and close. The RangeBar and RangeArea series need arrays of two values—the from and to value.
Array<number>
""
xAxis
Category axis

The configuration options of the category axis.

object
data

The category names. The Chart creates a category for every item of the array.

Array<string>
""
xaxis
object
data

The category names. The Chart creates a category for every item of the array.

Array<string>
""
Example 
{
  "charts": ""
}

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