Sign in
bookings

Export Bookings

Export the bookings matching the current filters as typed .xlsx / CSV.

Same filters, same query, same sort as list_bookings_endpoint — the file equals the screen by construction. Above the row cap the request 422s rather than truncating. Booking-scoped custom metrics export two columns each, resolved from each booking's own log-less result. Every export writes a durable ExportAudit row (metadata only, never row contents).

get/api/v1/bookings/export

Query parameters

propertystring[] nullable
property_excludestring[] nullable
wh_source_idstring nullable
channelstreamboolean nullable
status_codeBookingStatusCode[] nullable
originIngestionSource[] nullable
attribution_tierAttributionTier[] nullable
booked_fromstring date-time nullable
booked_tostring date-time nullable
stay_fromstring date nullable
stay_tostring date nullable
cancelled_fromstring date-time nullable
cancelled_tostring date-time nullable
discrepancy'feed_conflicts_human'

Booking-anchored discrepancy filter values (PR 6/PR 7).

judged_without_reservation is log-anchored (a stamped log with NO canonical reservation) and therefore lives on the logs surface — a bookings list cannot show a booking that doesn't exist.

unknown_commissionboolean nullable
format'xlsx' | 'csv'

File format: xlsx or csv.

File format: xlsx or csv.

columnsstring[] nullable

Ordered visible column keys to export. Core identity columns (booked / reservation / property) always export. Unknown keys 422.

Ordered visible column keys to export. Core identity columns (booked / reservation / property) always export. Unknown keys 422.

metric_idsstring[] nullable

Booking-scoped custom metrics to export — two columns each (result, score), resolved from each booking's own log-less result.

Booking-scoped custom metrics to export — two columns each (result, score), resolved from each booking's own log-less result.

report_namestring nullable

Filename stem (sanitized to ASCII kebab).

Filename stem (sanitized to ASCII kebab).

context_labelstring nullable

Human filter description for the workbook context header.

Human filter description for the workbook context header.

limitinteger nullable
offsetinteger nullable
pageinteger nullable

Deprecated - use offset.

Deprecated - use offset.

per_pageinteger nullable

Deprecated - use limit.

Deprecated - use limit.

start_datestring date nullable
end_datestring date nullable
date_fieldstring nullable

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

date_fromstring date-time nullable

Deprecated - use start_date.

Deprecated - use start_date.

date_tostring date-time nullable

Deprecated - use end_date.

Deprecated - use end_date.

use_created_atboolean nullable

Deprecated - use date_field=created_at.

Deprecated - use date_field=created_at.

property_ids_excludestring[] nullable
include_considered_hotelsboolean nullable

Include hotels the conversation was only considered for, not just the one it was attributed to.

Include hotels the conversation was only considered for, not just the one it was attributed to.

string uuid
OR
'__null__'
outcome_agent_refstring nullable
outcome_agent_refsstring[] nullable
outcome_agent_refs_excludestring[] nullable
outcome_agent_kind'ai_voice' | 'ai_text' | 'human' nullable
reviewedboolean nullable
statusstring nullable
has_booking_intentboolean nullable
has_bookingboolean nullable
booking_madeboolean nullable
booking_attributedboolean nullable
tag_idsstring[] nullable
countrystring nullable
selected_languagestring nullable
language_selection_sourcestring nullable
countriesstring[] nullable
countries_excludestring[] nullable
is_after_hoursboolean nullable
population_filtersstring[] nullable

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

searchstring nullable
standard_filtersstring nullable
metric_filtersstring nullable
sort_bystring nullable
sort_order'asc' | 'desc' nullable
strictboolean

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

voice_agent_idstring uuid nullable

Deprecated - use agent_id.

Deprecated - use agent_id.

metric_idstring uuid nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

metric_state'pass' | 'fail' | 'na' | 'not_run' | 'error' nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

booking_intentboolean nullable

Deprecated - use has_booking_intent.

Deprecated - use has_booking_intent.

Response

The export file (XLSX or CSV, per the format param).

{"stackTrail":"paths:/api/v1/bookings/export:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 3 of the 28 revisions of this API.1433

  • 704de2d43c75143See the full diff
    • ▲

      removed the enum value direct_pms from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value direct_pms from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value hotel_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value hotel_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value ota from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value ota from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value text_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value text_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value unknown from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value unknown from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value voice_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value voice_agent from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value website from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value website from the property anyOf[subschema #1]/items/ of the query request parameter originating_channel_exclude

      request-parameter-property-enum-value-removed

    • ●

      for the query request parameter originating_channel, the type of property anyOf[subschema #1]/items/ changed from string to no type

      request-parameter-property-type-changed

    • ●

      for the query request parameter originating_channel_exclude, the type of property anyOf[subschema #1]/items/ changed from string to no type

      request-parameter-property-type-changed

    • ●

      for the query request parameter property_ids, the type of property anyOf[subschema #1]/items/ changed from string to no type, and format from uuid to no format

      request-parameter-property-type-changed

  • 202b7d85683e2See the full diff
    • ○

      added the new optional query request parameter language_selection_source

      new-optional-request-parameter

    • ○

      added the new optional query request parameter selected_language

      new-optional-request-parameter

  • 0d816626f3621See the full diff
    • ○

      added the enum value mews_sync to the property anyOf[subschema #1]/items/ of the query request parameter origin

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 28 revisions, 1 has no diff computed.