---
title: "List conversions"
method: POST
path: "/reports/conversions"
tags: ["Reports"]
---

# List conversions

`POST /reports/conversions`

This endpoint returns conversion data for bookings within a specified date range.

**Note:** Conversions data is only provided for selected accounts based on contractual agreements.

Exactly one date filter must be provided. The available filters are:
- `booking_date_range`: Filter by the date the booking was made
- `cancellation_date_range`: Filter by the date the booking was cancelled
- `checkout_date_range`: Filter by the checkout date of the booking

Each date range must include both `from` and `to` dates in ISO-8601 format (YYYY-MM-DD).
Results are paginated with a default page size of 100 and a maximum of 1000 records per page.
Use the `page_token` from the response to retrieve subsequent pages.

**Example requests:**

Filter by booking date:
```json
{
  "booking_date_range": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  },
  "page_size": 100
}
```

Filter by cancellation date:
```json
{
  "cancellation_date_range": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  },
  "page_size": 100
}
```

Filter by checkout date:
```json
{
  "checkout_date_range": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  },
  "page_size": 100
}
```

## Request body

- union — Request object for retrieving conversion data. **Important:** Exactly one date filter must be provided. The date filters are mutually exclusive - specifying more than one will result in a 400 Bad Request error with `conflicting_parameters`. Available date filters (choose exactly one): - `booking_date_range`: Filter by when the booking was made - `cancellation_date_range`: Filter by when the booking was cancelled - `checkout_date_range`: Filter by the checkout date
  - object
    - `booking_date_range` object, required — Filter conversions by the date the booking was made. **Mutually exclusive** with cancellation_date_range and checkout_date_range.
      - `from` string, date, required — Start date of the range in ISO-8601 format (YYYY-MM-DD).
      - `to` string, date, required — End date of the range in ISO-8601 format (YYYY-MM-DD). Must be equal to or after the 'from' date.
    - `page_size` integer — Number of results per page. Default is 100, maximum is 1000.
    - `page_token` string — Token for retrieving the next page of results. Obtained from the previous response's pagination.next_page_token.
  - object
    - `cancellation_date_range` object, required — Filter conversions by the date the booking was cancelled. Only returns cancelled bookings. **Mutually exclusive** with booking_date_range and checkout_date_range.
      - `from` string, date, required — Start date of the range in ISO-8601 format (YYYY-MM-DD).
      - `to` string, date, required — End date of the range in ISO-8601 format (YYYY-MM-DD). Must be equal to or after the 'from' date.
    - `page_size` integer — Number of results per page. Default is 100, maximum is 1000.
    - `page_token` string — Token for retrieving the next page of results. Obtained from the previous response's pagination.next_page_token.
  - object
    - `checkout_date_range` object, required — Filter conversions by the checkout date of the booking. **Mutually exclusive** with booking_date_range and cancellation_date_range.
      - `from` string, date, required — Start date of the range in ISO-8601 format (YYYY-MM-DD).
      - `to` string, date, required — End date of the range in ISO-8601 format (YYYY-MM-DD). Must be equal to or after the 'from' date.
    - `page_size` integer — Number of results per page. Default is 100, maximum is 1000.
    - `page_token` string — Token for retrieving the next page of results. Obtained from the previous response's pagination.next_page_token.

## Response `200`

OK

- ConversionsResponse — Response object containing conversion data, pagination info, and metadata.
  - `conversions` Conversion[] — List of conversion records matching the search criteria.
    - `booking_date` string, date-time — The date and time when the booking was made (ISO 8601 datetime).
    - `cancellation_date` string, date-time — The date and time when the booking was cancelled, if applicable (ISO 8601 datetime).
    - `booking_reference` string — Unique reference identifier for the booking.
    - `checkin_date` string, date — The check-in date for the booking (YYYY-MM-DD).
    - `checkout_date` string, date — The check-out date for the booking (YYYY-MM-DD).
    - `label` string — Custom label associated with the booking, typically used for tracking campaigns or sources.
    - `booking_status` 'confirmed' | 'cancelled' | 'no_show' — Current status of the booking.
    - `commission_amount` string — The commission amount for this booking.
    - `commission_currency` string — The currency of the commission amount (ISO 4217 currency code).
    - `device_type` 'desktop' | 'mobile' — The type of device used to make the booking.
  - `pagination` ConversionsPagination — Pagination information for the conversions response.
    - `next_page_token` string — Token to use for retrieving the next page of results. Empty if there are no more pages.
    - `total_results` integer — Total number of conversion records matching the search criteria.
    - `total_pages` integer — Total number of pages available.
    - `random_page_access` boolean — Indicates whether random page access is supported. If false, only sequential pagination is available.
  - `metadata` ConversionsMetadata — Metadata about the conversions response.
    - `request_id` string — Unique identifier for this request, useful for debugging and support.
    - `timestamp` string, date-time — The timestamp when the response was generated (ISO 8601 datetime).
    - `result_count` integer — Number of conversion records returned in this response.

## Other responses

- `400` — Bad Request - Invalid input parameters

---

[API](https://skmtc.net/booking/apis/connect-api.md) · [All operations](https://skmtc.net/booking/apis/connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/booking/connect-api/revisions/0fbdc2f4423a/schema)