> ## 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. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > 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. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/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. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > 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. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Home > See this month's sales, live store activity and rep performance on the Overview, Live and Field tabs, and narrow them to one country. Use the **Home** screen to follow your company's sales and revenue for the month, see what's happening on your store right now, and check how your reps are doing. ## Where to find it In the admin sidebar, under **Analytics**, select **Home**. To open this screen, your role needs **View only** or **Full access** for **Payment Reports**. On the [Roles](/help/admin/settings/roles) screen, **Payment Reports** is in the **Commerce** card. Open the card and set access from the **Payment Reports** area's menu, not the card's. ## What's on the screen The screen has three tabs: **Overview**, **Live** and **Field**. It opens on **Overview**. There's no date picker. Where a card covers a period, its labels say so, such as **Month to date**. If your company has more than one country, a country selector sits at the right of the tab bar. It starts at **All countries**, and your default country is marked **(default)**. The country you choose applies to all three tabs. If the selector shows **Country filter failed — try again**, click it to reload the list. When there's no data yet, some cards show a short message and others show zeros. If a card can't load, click **Try again** on it. ### Overview The tab opens with today's date and three tiles: * **Yesterday**, with the day of the week: yesterday's revenue, how it compares with a typical day (**vs typical**), and the number of orders. * **Revenue MTD**: revenue so far this month. * **Tracking to**: the revenue the month is projected to reach. Below the tiles, a chart shows this month's revenue as a running total (**Actual**) inside a shaded **Expected range**. A dotted line shows last month for comparison. Click **vs last year** to compare with the same month last year instead, and **vs last month** to switch back. Under **The month's economics**: * **Revenue by order type**: this month's revenue per day, split into **Subscription**, **Enrollment**, **Web**, **Mobile**, **Backoffice** and **Admin** orders, with each type's total and percentage above the chart. Click **Orders** to count orders instead, and the title changes to **Orders by order type**. Click **Revenue** to switch back. * **Revenue by buyer type**: the same view split into **Member**, for orders your reps bought, and **Retail**, for orders from other customers. It has its own **Revenue** and **Orders** switch. * **Revenue quality**: how this month's revenue splits between **Returning** and **New** customers, and between **Subscriptions** and **One-time** orders. Below are the average order values: **AOV blended**, **AOV new** and **AOV returning**. * **Subscription engine**: renewals scheduled over the next 4 weeks. The card's description gives the total, and each week has a bar labeled **Week of** and its date. Below are **Subscribers**, with the net change; **Recovery**, the recovery rate for failed subscription payments; and **Cancels**, with the usual number after the slash. **View subscriptions** opens [Subscriptions](/help/admin/subscriptions). * **Payment recovery**: payments that failed this month. It shows the amount **won back**, the percentage recovered against the usual percentage, and how the failed payments split into **Recovered**, **Still retrying** and **Written off**, each with a count and amount. When payments are still retrying, a line below gives their total and number, and the most common reasons when known. **Review payments** opens the **Transactions** screen under **Payments**. Under **Where revenue comes from**: * **Channel economics**: revenue by channel (**Rep shares**, **Organic**, **Direct**, **Email**, **Social**, **Referral** and **Paid**), highest first. **\$ / visitor** is revenue per visitor, and **Change** is the change from the previous period. The card's description gives the period and how orders are credited to channels. **View traffic** opens the Traffic screen. * **Recent orders**: your latest paid orders. Each row shows the customer, the product, the location, how long ago the order came in, the rep (**via** and the rep's name) when there is one, and the amount. **See all orders** opens [Orders](/help/admin/orders). Under **Catalogue**: * **Best sellers**: this month's products ranked by revenue, with **Price** (the average price they sold for), **Units**, **Revenue** and a **Trend** line. * **Price distribution**: how your priced products spread across price bands, with each band's share as a percentage. The tallest bar is darker. The line below gives your product count and median price or, when your blended average order value is above the median, compares the two. See [Why does Price distribution count fewer products than I have?](#price-distribution-count) ### Live The **Live** tab shows what's happening on your store right now and refreshes on its own. Its header reads **Real time · as of** and the time of the last update. Four tiles follow: **Visitors now**, **Revenue today** (with **vs typical**), **Orders today** and **Reps active**. **Today so far** charts today's revenue hour by hour as a running total. When there's enough history, a dashed **Typical** line shows a typical day for this weekday, and the label at the latest point shows how far ahead or behind it you are. Under **Happening now**: * **Activity**: a feed of orders, shares and milestones. Each row shows who did what, how long ago, where, the rep (**via**) and the amount, when they apply. * **In motion**: money open right now. It shows **Active carts** with their potential value, **Abandoned** carts with the value lost, and **Failed payments** with the value at risk, each with a count. * **Top pages**: the pages visitors are on right now, with how many are on each. * **Where they are**: a world map and a list of the countries your visitors are in right now, with the total **online**. While you've chosen a country in the country selector, a note replaces this card. If updates fail or fall behind, the header reads **Stale** instead of **Real time**, and the affected cards show **Stale · showing snapshot from** and a time, or a note that they couldn't refresh. The numbers you see are from the last successful update. ### Field The **Field** tab shows how your reps are doing. Its header, **Field momentum**, has three tiles: * **Reps active yesterday**, with the typical number for that weekday. * **Active this month**: reps who shared or sold at least once. * **Rep revenue MTD**, with its approximate share of all revenue. Below them, a chart shows how many reps shared or sold each day over the last 14 days (**Reps active**) against the **Typical** number for that weekday. * **Rising**: reps gaining momentum, with a trend line and their revenue per month. * **Going quiet**: reps losing momentum, with how many days each has been silent, such as **12d silent**, and their monthly revenue at risk. **Send them a note** opens [Messaging](/help/admin/messages). * **Leaderboard**: top reps this month, with the columns **#**, **Move**, **Rep**, **Visitors**, **Orders**, **Revenue**, **Trend** and **Top asset**. **Move** shows how many places a rep moved up (▲) or down (▼), a dash if unchanged, or **NEW** for a rep ranking for the first time. **Top asset** shows the rep's top shared item, or **No shares yet**. ## Tasks ### Show one country's numbers At the right of the tab bar, open the selector. It reads **All countries** until you choose one. Choose a country. Every tab now shows that country's numbers. To see every country again, choose **All countries**. ### Find a rep on the leaderboard Click **Field** and scroll to **Leaderboard**. Type a name in **Search reps**. To narrow the list, choose **Climbing** for reps who moved up or **New** for reps ranking for the first time. **All** shows everyone. Choose **Revenue**, **Orders** or **Visitors** to sort by that column, highest first. ## Frequently asked questions * For an unusual day, compare **Actual** with the **Expected range** on the Overview chart, and check **vs typical** on the **Yesterday** and **Revenue today** tiles. * For growth, click **vs last year** above the Overview chart. * For your customer mix, check **Returning**, **New** and the AOV figures in **Revenue quality**. * For markets, choose each country in the country selector in turn. * For reps, check **Going quiet** and **Rising** on the Field tab. Click **See all orders** on the **Recent orders** card, or in the admin sidebar, under **Commerce**, select **Orders**. See [Orders](/help/admin/orders). It only appears when your company has two or more countries. To add a country, see [Open a country](/setup/open-a-country). It counts only products that are live on your retail store and have an active variant priced above zero in your default country, or in the country you've chosen in the country selector. Each product counts once, at its cheapest such price. Products without a price there aren't counted, so the number can be lower than your product count in [Products](/help/admin/products). Your role needs **View only** or **Full access** for **Payment Reports**. **Home** and Traffic both need it, so without it the **Analytics** group doesn't appear in the sidebar. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Orders](/help/admin/orders) * [Subscriptions](/help/admin/subscriptions) * [Messaging](/help/admin/messages) * [Roles](/help/admin/settings/roles) * [FairShare: sales rep attribution](/concepts/fair-share) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.