> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pagamerican.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Service status



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: PagAmerican Data API
  version: 1.0.0
  description: >-
    Sales analytics API for external consumers (creators and affiliates), served
    from ClickHouse in near real time.


    **Authentication:** send your API key (`pag_...`) directly in the
    `Authorization: Bearer <your_key>` header. There is no token exchange — the
    opaque key is the Bearer token itself.


    **Dates:** `from`/`to` are `YYYY-MM-DD` at 00:00:00 UTC; `from` is
    inclusive, `to` is exclusive. Max window 90 days. `/purchases` and `/orders`
    filter by **checkout initialization** (`checkoutInitializedAt`);
    `/checkouts` by load time; `/abandoned-carts` by session start; `/refunds`
    by request time.


    **Tenant scope:** you only receive your own account's data — isolation is
    enforced automatically by the key.
servers:
  - url: https://external-api-service.pagamerican.app
    description: Production
  - url: https://external-api-service.pagamerican.net
    description: Staging
security:
  - apiKey: []
tags:
  - name: purchases
    description: Purchases (creator and affiliate)
  - name: orders
    description: Orders (creator only)
  - name: products
    description: Product catalog (creator only)
  - name: offers
    description: Offer catalog (creator only)
  - name: checkouts
    description: Checkout sessions (creator only)
  - name: abandoned-carts
    description: Abandoned carts (creator only)
  - name: refunds
    description: Refunds, chargebacks and alerts (creator and affiliate)
  - name: health
    description: Service status
paths:
  /health:
    get:
      tags:
        - health
      summary: Service status
      responses:
        '200':
          description: Operational
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
      security: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Your opaque API key (`pag_...`) sent directly as the Bearer token. There
        is no token/JWT exchange.

````