Stay22
DashboardSupport
Getting StartedAPIReporting APIAllezMapsMobile SDK

Retrieve partner transaction

Retrieve partner transactions

GET/v1/reporting/transactions

Authorization

X-API-KEY<token>

API key. Required on every request. Contact your Stay22 representative to obtain one.

In: header

Query Parameters

thirdParty*string

Your platform name as registered with Stay22 (e.g., "inc", "helloworld"). Required for identification.

startDate?string

Start of the date range. The field filtered depends on the dateFilter parameter (defaults to lastUpdatedDate). Defaults to 1 year before the current date. Format: YYYY-MM-DD.

endDate?string

End of the date range. The field filtered depends on the dateFilter parameter (defaults to lastUpdatedDate). Defaults to the current date. Format: YYYY-MM-DD.

dateFilter?string

Which date field the startDate/endDate range filters on. Default: lastUpdatedDate.

format?string

Response format. "csv" returns text/csv, "json" returns application/json. Default: csv.

page?integer

Zero-indexed page number for pagination. Use with limit. Default: 0.

limit?integer

Number of records per page. Range: 1-500. Default: 500.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/reporting/transactions?thirdParty=string"
{  "statusCode": 0,  "partnerId": "string",  "data": [    {      "provider": "string",      "bookingId": "string",      "bookedDate": "string",      "startDate": "string",      "endDate": "string",      "bookingStatus": "string",      "campaignId": "string",      "campaignIds": [],      "commission": "string",      "currency": "string",      "category": "string",      "quantity": 0,      "information": "string",      "destination": "string",      "userCountry": "string",      "device": "string",      "lastUpdatedDate": "string",      "property1": null,      "property2": null    }  ],  "property1": null,  "property2": null}
{  "statusCode": 0,  "error": "string",  "code": "string",  "message": "string",  "requestId": "string",  "details": {    "property1": null,    "property2": null  },  "provider": "string"}
{  "statusCode": 0,  "error": "string",  "code": "string",  "message": "string",  "requestId": "string",  "details": {    "property1": null,    "property2": null  },  "provider": "string"}
{  "statusCode": 0,  "error": "string",  "code": "string",  "message": "string",  "requestId": "string",  "details": {    "property1": null,    "property2": null  },  "provider": "string"}
{  "statusCode": 0,  "error": "string",  "code": "string",  "message": "string",  "requestId": "string",  "details": {    "property1": null,    "property2": null  },  "provider": "string"}
{  "statusCode": 0,  "error": "string",  "code": "string",  "message": "string",  "requestId": "string",  "details": {    "property1": null,    "property2": null  },  "provider": "string"}