Skip to content
Wink

Generate Wink Extranet report for property

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/report/csv
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/report/csv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "reportName": "", "reportDataType": "PROPERTY", "fieldNames": "", "state": "" }'

Generates a CSV report filtered to show only bookings associated with the specified property (hotel). The report excludes failed bookings and shows inventory-specific metrics.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Unique identifier for the property (hotel) managing entity

Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

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

Name of the report for the generated CSV file

string
"" >= 1 characters
Example 
booking-summary
reportDataType
required

Type of data source to query from: PROPERTY (hotel inventory), USER (guest profiles), BOOKING (reservations), ACCOUNT (managing entity data)

string
""
Allowed values: PROPERTY USER BOOKING ACCOUNT
Example 
BOOKING
fieldNames
required

List of field definitions specifying which data fields to include and their display titles

Array<object>
"" >= 1 items
object
title
required

Display name for the report column

string
"" >= 1 characters
Example 
Property Name
valuePath
required

JSON path to the field in the data object (dot-notation)

string
"" >= 1 characters
Example 
hotel.name
state
required

Query state with sorting, filtering, and pagination criteria to retrieve the report data

object
skip

Number of records to be skipped by the pager.

integer format: int32
0
Example 
0
take

Number of records to take.

integer format: int32
default: 30 >= 1 <= 180
Example 
10
sort

Descriptors used for sorting result set.

Array<object>
""
object
dir

Descriptors used for sorting result set

string
""
Allowed values: asc desc
Example 
asc
field

Data set field to sort on

string
""
Example 
hotel.name
filter

Descriptors used for filtering result set

object
logic

Whether to filter inclusively or exclusively

string
""
Allowed values: and or
Example 
and
filters

Descriptors used for filtering the result set

Array<object>
""
object
field
required

Field name to filter on

string
"" >= 1 characters
Example 
hotel.name
operator
required

Filter operator to use on field

string
""
Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin
Example 
startsWith
value

Value to filter dataset against

""
Example 
Happy Res
ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean
Example 
true
group

Descriptors to group result sets by.

Array<object>
""
object
field

Field to group data set on

string
""
Example 
createdDate
dir

Group sort direction

string
""
Allowed values: asc desc
Example 
asc
aggregates

Primitive aggregate data points

Array<object>
""
object
field

Field to run aggregate function on

string
""
Example 
hotel.bookings
aggregate

Aggregate function

string
""
Allowed values: count sum average min max
Example 
count

Responses

Section titled “ Responses ”

200

Section titled “200 ”

CSV report generated successfully and returned as a file download

400

Section titled “400 ”

Invalid report query (missing required fields or invalid data type)

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 ”

User does not have BOOKING:READ permission for the specified property

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

503

Section titled “503 ”

Service Unavailable

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties