v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Analytics

Guest nationality (source market) report

Overview

Returns analytics on the source markets (guest nationality) of bookings. Compares the current period to the previous period of equal length, with per-nationality booking counts, sales in USD, average booking value, and period-over-period change.

When to Use

  • Source market analysis - See which nationalities drive the most bookings and sales
  • Period comparison - Compare current vs previous period totals and per-nationality growth
  • Geographic dashboards - Track performance by guest country (ISO code)
  • Marketing and sales planning - Identify growing or declining markets

What You Get

  • Period definition - Date ranges for current and previous periods
  • Summary - Total sales (USD), change percent/amount, and count of nationalities
  • Per-nationality data - For each guest nationality: booking count, total sales USD, avg booking value; current and previous period; and change (sales percent/amount, booking count change)
  • New markets - Nationalities with no previous-period data have previous_period: null and change expressed as 100% growth

Quick Start

Pass query parameters from, to, and sandbox. The API derives the previous period (same length, immediately before). Returns period metadata, summary totals, and an array of nationality-level metrics.

get/bookings/guest-nationality-report

Query parameters

fromstring date required

Start date of the current period YYYY-MM-DD (ISO 8601)

tostring date required

End date of the current period YYYY-MM-DD (ISO 8601)

sandboxstring

Filter by environment: "true" for sandbox, "false" for production

Response

Guest nationality report retrieved successfully