Skip to main content
GET
Commercial performance over a period

Authorizations

Authorization
string
header
default:sk_test_DEMO0000_replace_with_your_sandbox_key
required

API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.

Production sk_live_* keys must additionally sign every write request (POST/PUT/DELETE) with the X-Timestamp and X-Signature headers. Sandbox sk_test_* keys are exempt from request signing: X-Signature and X-Timestamp are not required for writes in the sandbox (so the developer-portal "Try it" playground works end to end). The Idempotency-Key header remains required on writes in both environments.

Query Parameters

from
string<date>
required

First day of the period, inclusive.

to
string<date>
required

Last day of the period, inclusive.

Response

Commercial snapshot for the requested period.

period
object
required
bookings_count
integer<int64>
required

Firm bookings created within the period.

travelers_count
integer<int64>
required

Adults plus children across those bookings.

gross_merchandise_value
object
required

Total charged to customers, your surcharge included.

partner_revenue
object
required

What you keep = commission share + surcharge.

amount_due_to_safariat
object
required

Total reversed to Safariat over the period.

effective_take_rate_percent
string
required

partner_revenue / gross_merchandise_value, as a percentage with two decimals. 0.00 on an empty period.

Example:

"1.67"

average_basket
object
required

Gross merchandise value divided by the number of bookings.

travelers_per_booking
string
required

Two decimals. 0.00 on an empty period.

Example:

"2.29"

cancelled_bookings_count
integer<int64>
required
cancelled_value
object
required

Original customer price of the cancelled bookings.

cancellation_rate_percent
string
required

Share of value, not of headcount.

Example:

"7.09"

cancellations_by_reason
object[]
required

Ordered by decreasing booking count. unspecified groups cancellations recorded without a reason. Only the reason code is reported: any free-text note you attach when cancelling is stripped, so the breakdown stays aggregated by cause rather than fragmenting into one row per note.