> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. # Average Latency By Provider average latency by provider > Returns the average payment gateway response time, in milliseconds, as a separate time series for each provider (integration class plus gateway adapter class) the current company used in the period, each with its own KPIs. Accepts the same filters as the other reports except `integration_class` and `adapter_class`, since the report is already split by provider. Always scoped to the caller's company. A `custom` period without a valid `start_date` / `end_date` pair returns 400. Requires a company admin Bearer token with the `reports.view` permission. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v202506/payments/company_reports/average_latency_by_provider openapi: 3.1.0 info: title: Fluid Admin v2025-06 API version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/v202506/payments/company_reports/average_latency_by_provider: get: tags: - payments summary: Average Latency By Provider average latency by provider description: >- Returns the average payment gateway response time, in milliseconds, as a separate time series for each provider (integration class plus gateway adapter class) the current company used in the period, each with its own KPIs. Accepts the same filters as the other reports except `integration_class` and `adapter_class`, since the report is already split by provider. Always scoped to the caller's company. A `custom` period without a valid `start_date` / `end_date` pair returns 400. Requires a company admin Bearer token with the `reports.view` permission. operationId: admin_v2025_06_payments_company_reports_average_latency_by_provider_get parameters: - name: period in: query required: true description: >- Reporting period for the time series. Use `custom` together with `start_date` and `end_date`. schema: type: string enum: - last_24_hours - last_7_days - last_30_days - last_month - last_year - custom - name: start_date in: query required: false description: >- ISO 8601 start of a `custom` period. Required when `period` is `custom`; must be before `end_date`. schema: type: string format: date-time - name: end_date in: query required: false description: >- ISO 8601 end of a `custom` period. Required when `period` is `custom`. schema: type: string format: date-time - name: interval in: query required: false description: >- Time-series bucket size. Allowed values depend on `period`; defaults per period when omitted. schema: type: string enum: - hourly - daily - weekly - monthly responses: '200': description: Success content: application/json: example: providers: - integration_class: CreditCard adapter_class: ActiveMerchant::Billing::NmiGateway data_points: - timestamp: '2026-09-23T00:00:00Z' value: 598.2 interval: daily - timestamp: '2026-09-24T00:00:00Z' value: 571.4 interval: daily - timestamp: '2026-09-25T00:00:00Z' value: 622.9 interval: daily - timestamp: '2026-09-26T00:00:00Z' value: 688.1 interval: daily - timestamp: '2026-09-27T00:00:00Z' value: 640.7 interval: daily - timestamp: '2026-09-28T00:00:00Z' value: 580.3 interval: daily - timestamp: '2026-09-29T00:00:00Z' value: 609.5 interval: daily - timestamp: '2026-09-30T00:00:00Z' value: null interval: daily kpis: total: 615.87 previous_period_total: 652.3 growth: value: -36.43 percent: -5.58 average: 615.87 min: 571.4 max: 688.1 - integration_class: Bread adapter_class: null data_points: - timestamp: '2026-09-23T00:00:00Z' value: 842.6 interval: daily - timestamp: '2026-09-24T00:00:00Z' value: null interval: daily - timestamp: '2026-09-25T00:00:00Z' value: 901.3 interval: daily - timestamp: '2026-09-26T00:00:00Z' value: null interval: daily - timestamp: '2026-09-27T00:00:00Z' value: 877.9 interval: daily - timestamp: '2026-09-28T00:00:00Z' value: null interval: daily - timestamp: '2026-09-29T00:00:00Z' value: null interval: daily - timestamp: '2026-09-30T00:00:00Z' value: null interval: daily kpis: total: 873.93 previous_period_total: 910.44 growth: value: -36.51 percent: -4.01 average: 873.93 min: 842.6 max: 901.3 period: from: '2026-09-23T00:00:00Z' to: '2026-09-30T23:59:59Z' interval: daily previous_period: from: '2026-09-15T00:00:00Z' to: '2026-09-23T00:00:00Z' meta: request_id: c0a8012e-7f3b-4d6a-9e21-5b8d4f2a6c17 timestamp: '2026-09-30T14:15:22Z' schema: type: object properties: providers: type: array items: type: object properties: integration_class: type: string adapter_class: type: - string - 'null' data_points: type: array items: type: object properties: timestamp: type: string format: date-time value: type: - number - 'null' description: >- Average latency in milliseconds; null for a bucket with no timed payments from this provider. interval: type: string kpis: type: object properties: total: type: number previous_period_total: type: number growth: type: object properties: value: type: number percent: type: number average: type: number min: type: number max: type: number period: type: object properties: from: type: string format: date-time to: type: string format: date-time interval: type: string previous_period: type: object properties: from: type: string format: date-time to: type: string format: date-time meta: $ref: '#/components/schemas/Meta' additionalProperties: false '400': description: >- Invalid custom period (missing or mis-ordered `start_date`/`end_date`) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: type: object description: >- Rotulus cursor-pagination metadata (Api::MetaPagination#to_h), present on cursor-paginated responses such as GET /api/v2025-06/prices. total_count is only present when the endpoint opts into a total count. properties: cursor: type: - string - 'null' limit: type: integer prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' total_count: type: integer ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer ````