> ## Documentation Index > Fetch the complete documentation index at: https://developers.safarapi.com/llms.txt > Use this file to discover all available pages before exploring further. # How many quotes turn into bookings > Conversion of the quotes you issued over a period. This is the one figure only we can give you: the funnel runs across your application and our API, and neither side holds both ends alone. `quotes_expired_unused` counts quotes that reached their expiry without a booking. A high share points at friction after the price is shown — the customer saw the amount and gave up — which is corrected on your side, not ours. Quotes are attributed to the period in which they were **issued**, so a quote issued on the last day and booked the day after still counts as converted. The period is capped at 366 days. Read-only. ## OpenAPI ````yaml /api-reference/openapi.yaml get /metrics/quote-funnel openapi: 3.1.0 info: title: SafarAPI version: 1.0.0 summary: B2B API for banking partners — Safariat catalog and booking description: > SafarAPI lets banking partners integrate the Safariat travel catalog into their authenticated customer areas and book on behalf of their own end customers who are already authenticated and KYC-verified on the bank side. ## Channel model - The traveler never authenticates with Safariat. - Payment is collected on the banking platform (out-of-band from Safariat). - The bank submits the HMAC-signed payment confirmation at booking time. - Monthly post-payment settlement (see `GET /settlements`). ## Authentication Bearer API key in the `Authorization` header. Format `sk_live__` (production) or `sk_test__` (sandbox). The secret is shown only once at key generation — Safariat stores only an argon2id hash. ## Write request signing Production write requests (`POST`, `PUT`, `DELETE`) additionally require: - `X-Timestamp`: Unix timestamp in seconds, validity window ±5 minutes. - `X-Signature`: `hex(HMAC_SHA256(secret, "{timestamp}\n{method}\n{path}\n{body}"))`. - `Idempotency-Key`: opaque string unique per operation (UUID v4 recommended), retained for 24 h. Replayed responses carry an `Idempotent-Replayed: true` header. Request signing applies only to production `sk_live_*` keys. 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). `Idempotency-Key` is still required on writes in both environments. ## Error format All errors follow the `Error` schema with a stable i18n code, an English message, and the `request_id` for correlation with Safariat logs. ## Versioning URL-based versioning (`/v1`). No breaking changes within a version. Removals are announced 6 months in advance via the `Sunset` header (RFC 8594). ## Rate limiting Default limit of 600 req/min per key, contractually adjustable. The `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers are returned on every response. Exceeding the limit → `429 Too Many Requests` plus the `Retry-After` header. ## Sandbox An `sk_test_*` key targets the same infrastructure as production but isolates bookings in `test_mode=true`: no settlement is issued, webhooks carry `test: true`, and operators are never notified. Traveller emails are still delivered, to the address supplied in the request and with a `[TEST]` subject prefix, so that the traveller journey can be validated end to end before going live. contact: name: SafarAPI Team email: api@safariat.ma url: https://developers.safariat.ma license: name: Proprietary — use subject to a signed partner agreement termsOfService: https://safariat.ma/legal/partner-terms servers: - url: https://api.safarapi.com/api/partner/v1 description: >- Production and sandbox share this host. The environment is selected by the API key prefix: sk_live_ targets production, sk_test_ targets the sandbox. security: - apiKey: [] tags: - name: Meta description: Metadata for the current key, service health. - name: Catalog description: Browsing the Safariat adventure catalog. - name: Quotes description: Price-locked quotes (30 min TTL) ahead of booking. - name: Bookings description: Creating, retrieving, and cancelling bookings. - name: Settlements description: Monthly Safariat → partner payout invoices. - name: Webhooks description: Managing endpoints that receive Safariat events. - name: Team description: Members of the partner console workspace and their roles. - name: Reviews description: Read-only access to traveler reviews on the Safariat catalog. - name: Files description: Presigned uploads for partner-supplied files (currently review photos). paths: /metrics/quote-funnel: get: tags: - Dashboard summary: How many quotes turn into bookings description: > Conversion of the quotes you issued over a period. This is the one figure only we can give you: the funnel runs across your application and our API, and neither side holds both ends alone. `quotes_expired_unused` counts quotes that reached their expiry without a booking. A high share points at friction after the price is shown — the customer saw the amount and gave up — which is corrected on your side, not ours. Quotes are attributed to the period in which they were **issued**, so a quote issued on the last day and booked the day after still counts as converted. The period is capped at 366 days. Read-only. operationId: getQuoteFunnel parameters: - name: from in: query required: true schema: type: string format: date - name: to in: query required: true schema: type: string format: date responses: '200': description: Quote conversion over the requested period. content: application/json: schema: $ref: '#/components/schemas/QuoteFunnel' example: period: from: '2026-08-01' to: '2026-08-31' searches: 900 adventure_views: 400 quotes_issued: 200 quotes_converted: 47 quotes_abandoned: 153 quotes_expired_unused: 120 search_to_view_rate_percent: '44.44' view_to_quote_rate_percent: '50.00' conversion_rate_percent: '23.50' expiry_rate_percent: '60.00' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: QuoteFunnel: type: object required: - period - searches - adventure_views - quotes_issued - quotes_converted - quotes_abandoned - quotes_expired_unused - search_to_view_rate_percent - view_to_quote_rate_percent - conversion_rate_percent - expiry_rate_percent properties: period: type: object required: - from - to properties: from: type: string format: date to: type: string format: date searches: type: integer format: int64 description: Catalogue search calls over the period. adventure_views: type: integer format: int64 description: Adventure detail calls availability lookups excluded.: null quotes_issued: type: integer format: int64 quotes_converted: type: integer format: int64 description: Quotes that led to a booking whenever that booking happened.: null quotes_abandoned: type: integer format: int64 description: Issued minus converted. quotes_expired_unused: type: integer format: int64 description: Reached expiry without a booking. search_to_view_rate_percent: type: string example: '44.44' view_to_quote_rate_percent: type: string example: '50.00' conversion_rate_percent: type: string example: '23.50' expiry_rate_percent: type: string example: '60.00' Error: type: object required: - code - message - request_id properties: code: type: string description: | Stable, documented i18n code. Form `domain.subdomain.detail` (e.g. `payment.amount.mismatch`, `auth.api_key.invalid`). example: validation.required.field message: type: string description: >- English message (for bank logs). API errors are never localized on the Safariat side. example: Field 'rate_pack_id' is required. request_id: type: string description: Unique request ID on the Safariat side. details: type: object description: Optional structured details (offending field, expected value, etc.). additionalProperties: true responses: BadRequest: description: > Malformed request (syntactic validation). A request body carrying a field this endpoint does not declare is rejected with `partner.request.field.unknown`, naming the offending field. Unknown fields are never ignored: a misspelling would otherwise drop data silently, and on `POST /quotes` that means quoting a party smaller than the one you sent. content: application/json: schema: $ref: '#/components/schemas/Error' examples: missingField: value: code: validation.required.field message: Field 'rate_pack_id' is required. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC unknownField: value: code: partner.request.field.unknown message: Unknown field 'children_ages' in the request body. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHD Unauthorized: description: API key missing, invalid, expired, or incorrect HMAC signature. content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing: value: code: auth.api_key.missing message: Authorization header is required. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC invalid: value: code: auth.api_key.invalid message: The provided API key is invalid or has been revoked. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC signatureInvalid: value: code: auth.signature.invalid message: HMAC signature does not match. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC timestampSkew: value: code: auth.timestamp.skew message: Timestamp is more than 5 minutes off server time. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC Forbidden: description: Authenticated but not authorized (missing scope, non-allowlisted IP). content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Rate limit exceeded for the current key. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' example: code: rate_limit.exceeded message: Rate limit exceeded for this API key. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC headers: RetryAfter: schema: type: integer description: Seconds to wait before the next attempt (RFC 7231). XRateLimitLimit: schema: type: integer description: Request limit per minute for the current key. XRateLimitRemaining: schema: type: integer description: Requests remaining in the current window. XRateLimitReset: schema: type: integer format: int64 description: Unix timestamp (s) at which the window resets. securitySchemes: apiKey: type: http scheme: bearer bearerFormat: sk_live__ or sk_test__ x-default: sk_test_DEMO0000_replace_with_your_sandbox_key description: > 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. ````