# Shoffi Docs ## Shoffi Docs - [Getting Started](https://docs.shoffi.app/getting-started.md): An introduction to the Shoffi platform - [Adding a new app](https://docs.shoffi.app/for-app-owners/adding-a-new-app.md) - [Google Analytics integration](https://docs.shoffi.app/for-app-owners/google-analytics-integration.md) - [BigQuery integration](https://docs.shoffi.app/for-app-owners/bigquery-integration.md) - [The affiliate terms](https://docs.shoffi.app/for-app-owners/the-affiliate-terms.md) - [Affiliate groups](https://docs.shoffi.app/for-app-owners/affiliate-groups.md) - [Managing affiliates](https://docs.shoffi.app/for-app-owners/managing-affiliates.md) - [Invite affiliates](https://docs.shoffi.app/for-app-owners/invite-affiliates.md) - [Paying affiliates](https://docs.shoffi.app/for-app-owners/paying-affiliates.md) - [Managing your apps](https://docs.shoffi.app/for-app-owners/managing-your-apps.md) - [Managing your team](https://docs.shoffi.app/for-app-owners/managing-your-team.md) - [Integrations (Webhooks & API Key)](https://docs.shoffi.app/for-app-owners/integrations-webhooks.md) - [Shoffi Metrics (Beta)](https://docs.shoffi.app/for-app-owners/shoffi-metrics-beta.md): Shoffi Metrics helps you understand how your app is performing by showing key business metrics like MRR, churn, LTV, and revenue breakdowns. - [Choosing/Upgrading a plan](https://docs.shoffi.app/subscriptions/choosing-upgrading-a-plan.md) - [Plan limits](https://docs.shoffi.app/subscriptions/plan-limits.md) - [Changing billing details](https://docs.shoffi.app/subscriptions/changing-billing-details.md) - [Downgrade and cancellation](https://docs.shoffi.app/subscriptions/downgrade-and-cancellation.md) - [Frozen and Deactivated accounts](https://docs.shoffi.app/subscriptions/frozen-and-deactivated-accounts.md) - [Introduction to Shoffi API](https://docs.shoffi.app/the-shoffi-api/introduction-to-shoffi-api.md) - [Get All Affiliates](https://docs.shoffi.app/the-shoffi-api/get-all-affiliates.md) - [Get Affiliate Info](https://docs.shoffi.app/the-shoffi-api/get-affiliate-info.md) - [Create New Affiliate](https://docs.shoffi.app/the-shoffi-api/create-new-affiliate.md) - [Add Bonus Reward](https://docs.shoffi.app/the-shoffi-api/add-bonus-reward.md) - [Update Affiliate Terms](https://docs.shoffi.app/the-shoffi-api/update-affiliate-terms.md) - [Add Referral](https://docs.shoffi.app/the-shoffi-api/add-referral.md) - [Affiliate Payment Request](https://docs.shoffi.app/the-shoffi-api/affiliate-payment-request.md) - [Connecting to new apps](https://docs.shoffi.app/for-affiliates/connecting-to-new-apps.md) - [Referral links](https://docs.shoffi.app/for-affiliates/referral-links.md) - [Manual referrals](https://docs.shoffi.app/for-affiliates/manual-referrals.md) - [Payout requests](https://docs.shoffi.app/for-affiliates/payout-requests.md) - [Performance analytics](https://docs.shoffi.app/for-affiliates/performance-analytics.md) - [Connected app information](https://docs.shoffi.app/for-affiliates/connected-app-information.md) - [The markets](https://docs.shoffi.app/general/the-markets.md) - [The affiliate commission](https://docs.shoffi.app/general/the-affiliate-commission.md) - [Disputes](https://docs.shoffi.app/general/disputes.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.shoffi.app/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.