> ## Documentation Index > Fetch the complete documentation index at: https://help.onlyx.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > You are reading OnlyX Help: the OnlyX Help Center and the OnlyX developer documentation. OnlyX is an AI chatting and CRM platform for OnlyFans agencies. Its AI chatter is called Hugo in the app. > Pages at the site root (for example /inbox/..., /hugo/..., /billing/...) are Help Center articles for agency owners, admins, chatters and creators who use the app at app.onlyx.ai. Words in bold are the exact button, menu and label names the app shows; keep them exactly as written. When these pages do not answer a question, the person can email support at support@onlyx.ai. > Pages under /developers are the developer documentation. REST API base URL: https://api.onlyx.ai/v1 (authenticate with `Authorization: Bearer `; keys start with onx_sk_ and are created in app.onlyx.ai under Settings > API & MCP). MCP server: https://mcp.onlyx.ai/mcp (OAuth, or a Bearer API key). In the API the AI chatter is `ai` on the wire. Money is integer US cents in fields ending in Cents; timestamps are UTC ISO-8601. > Rules for assistants acting on a user's behalf: discover ids with list calls and never invent them; before any call that reaches a real fan or the live OnlyFans account (sending a message, releasing a chat to the AI, turning AI on for a chat, resolving a hand-off, turning review mode off, changing the welcome message, creating a tracking link) show the user the exact content and get explicit confirmation; send every POST with an Idempotency-Key and reuse it on retry; never resend a message whose delivery status is unconfirmed; never ask a creator for her OnlyFans password or codes - she signs in herself through a connect link and the OnlyX Login app. # Get the audience > Summarises the fans: how many are active, expired or not yet reported by OnlyFans, auto-renew among active fans, how they spread over lifetime-spend bands, how many wrote in the last 7, 30 and 90 days, and week-over-week retention of fans who write. Covers every creator the credential can see, or one with `creatorId` (a creator it cannot see is `404 CREATOR_NOT_FOUND`). Cached for several minutes. Limited to 20 requests per minute per credential across all `/stats` endpoints. **Scope:** requires `stats:read`. **Rate limits:** 20 requests to `/stats` endpoints per 60 seconds per credential — on top of the general limit of 120 requests per 60 seconds per credential. ## OpenAPI ````yaml /developers/api-reference/openapi.json get /v1/stats/audience openapi: 3.1.0 info: contact: email: developers@onlyx.ai name: OnlyX developers url: https://docs.onlyx.ai/ description: > The OnlyX API runs your OnlyX workspace from your own code and AI tools: creators and their connection, the fan inbox, fans, vault media, statistics, the AI chatter's setup and tracking links. **Authentication.** Send an API key as `Authorization: Bearer onx_sk_…` (create one in OnlyX under Settings → API & MCP), or an OAuth access token issued to a connected app. Keys belong to the workspace, carry scopes, and can be limited to some creators. **Conventions.** JSON with camelCase fields; timestamps are ISO-8601 UTC with a `Z`; money is integer US cents (fields end in `Cents`). Lists return `{"data": [...], "hasMore": bool, "nextCursor": string|null}` and page with `limit` and `cursor`. **Scopes.** Every operation names the scope it needs in `x-required-scope` and in its description; a credential without it gets `403 INSUFFICIENT_SCOPE`. **Errors and limits.** Errors are `{"error": {"code", "message", "requestId"}}`; every response carries `X-Request-Id`. The default limit is 120 requests per 60 seconds per credential, reported in `X-RateLimit-*` headers; over it you get `429 RATE_LIMITED` with `Retry-After`. Operations with limits of their own list them in `x-rate-limits`. **Idempotency and safety.** Every write accepts an `Idempotency-Key` header (required when sending a message, adding a creator and creating a tracking link): retry with the same key and you get the original answer instead of a second action. Operations marked `x-reaches-fans: true` can reach a real fan or change the live OnlyFans account. Guides, the MCP server and more: [docs.onlyx.ai](https://docs.onlyx.ai). summary: >- Run your OnlyX workspace (creators, inbox, fans, stats and the AI chatter) from code and AI tools. title: OnlyX API version: 1.0.0 servers: - description: Production url: https://api.onlyx.ai security: - bearerAuth: [] tags: - description: 'Who you are: the workspace and credential behind a key.' name: Workspace - description: >- The creators your workspace manages: list, read, add, rename, and the AI switch. name: Creators - description: >- Connecting a creator's OnlyFans account: connect links she opens on her own device, and the connection status to poll. name: Connect - description: >- The fan inbox: list and count conversations, read state, take over, release, and the per-chat AI switch. name: Conversations - description: Read message history and send text, free media and paid messages to fans. name: Messages - description: Conversations the AI chatter handed to your team, and resolving them. name: Hand-offs - description: >- Fans, their purchases, fan lists, and your team's notes, custom names and mute flag. name: Fans - description: >- Each creator's OnlyFans vault: media ids for messages and levels, and thumbnails. name: Media - description: >- Today, revenue, audience, the cached overview report, and each creator's transaction ledger. name: Stats - description: The brief the AI chatter follows to chat as each creator. name: AI persona - description: 'The AI content ladder: folders, ladders, priced levels and their media.' name: AI content - description: >- Follow-ups, review mode, the master AI switch, and OnlyFans' welcome message. name: AI settings - description: >- OnlyFans tracking and trial links, your cost fields, and creating new links. name: Tracking links externalDocs: description: OnlyX developer documentation url: https://docs.onlyx.ai paths: /v1/stats/audience: get: tags: - Stats summary: Get the audience description: >- Summarises the fans: how many are active, expired or not yet reported by OnlyFans, auto-renew among active fans, how they spread over lifetime-spend bands, how many wrote in the last 7, 30 and 90 days, and week-over-week retention of fans who write. Covers every creator the credential can see, or one with `creatorId` (a creator it cannot see is `404 CREATOR_NOT_FOUND`). Cached for several minutes. Limited to 20 requests per minute per credential across all `/stats` endpoints. **Scope:** requires `stats:read`. **Rate limits:** 20 requests to `/stats` endpoints per 60 seconds per credential — on top of the general limit of 120 requests per 60 seconds per credential. operationId: getAudience parameters: - description: >- Only this creator (`cre_…`). Without it, every creator the credential can see. A creator the credential cannot see is `404 CREATOR_NOT_FOUND`, never an empty report. in: query name: creatorId required: false schema: anyOf: - maxLength: 64 minLength: 1 type: string - type: 'null' description: >- Only this creator (`cre_…`). Without it, every creator the credential can see. A creator the credential cannot see is `404 CREATOR_NOT_FOUND`, never an empty report. title: Creatorid responses: '200': content: application/json: example: activity: last30Days: 1311 last7Days: 640 last90Days: 1950 asOf: '2026-09-26T14:00:02.000Z' fans: active: 2210 expired: 520 spenders: 1439 total: 2841 unknown: 111 renewal: 'off': 318 'on': 1892 retention: currentEnd: '2026-09-25' currentStart: '2026-09-19' previousEnd: '2026-09-18' previousFans: 580 previousStart: '2026-09-12' rate: 0.693 retainedFans: 402 spendBands: - band: none fans: 1402 - band: under_50 fans: 1022 - band: 50_to_200 fans: 314 - band: 200_plus fans: 103 timezone: Europe/London schema: $ref: '#/components/schemas/AudienceReport' description: The fans by status, renewal, spend band, activity and retention. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '400': content: application/json: examples: VALIDATION_ERROR: summary: VALIDATION_ERROR value: error: code: VALIDATION_ERROR message: 'creatorId: String should have at most 64 characters' requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- The request is not valid and was not carried out. Fix it before retrying. `VALIDATION_ERROR`: the request is not valid; `message` names the field and the problem. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '401': $ref: '#/components/responses/Unauthorized' '403': content: application/json: examples: INSUFFICIENT_SCOPE: summary: INSUFFICIENT_SCOPE value: error: code: INSUFFICIENT_SCOPE message: This key does not have the `stats:read` scope. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 WORKSPACE_SUSPENDED: summary: WORKSPACE_SUSPENDED value: error: code: WORKSPACE_SUSPENDED message: This workspace is suspended. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- The credential may not do this. `INSUFFICIENT_SCOPE`: the credential lacks the `stats:read` scope (the `WWW-Authenticate` header names it; an OAuth token's message says "token" instead of "key"). `WORKSPACE_SUSPENDED`: the workspace is suspended. headers: WWW-Authenticate: $ref: '#/components/headers/WWW-Authenticate' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '404': content: application/json: examples: CREATOR_NOT_FOUND: summary: CREATOR_NOT_FOUND value: error: code: CREATOR_NOT_FOUND message: Creator not found. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Not found. An id that does not exist, belongs to another workspace, or is outside this credential's creators all get the same answer. `CREATOR_NOT_FOUND`: the `creatorId` filter names a creator this credential cannot see (never an empty result). headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: AudienceReport: description: >- Who the fans are: subscription status, renewal, spend and activity. New fields may be added. examples: - activity: last30Days: 1311 last7Days: 640 last90Days: 1950 asOf: '2026-09-26T14:00:02.000Z' fans: active: 2210 expired: 520 spenders: 1439 total: 2841 unknown: 111 renewal: 'off': 318 'on': 1892 retention: currentEnd: '2026-09-25' currentStart: '2026-09-19' previousEnd: '2026-09-18' previousFans: 580 previousStart: '2026-09-12' rate: 0.693 retainedFans: 402 spendBands: - band: none fans: 1402 - band: under_50 fans: 1022 - band: 50_to_200 fans: 314 - band: 200_plus fans: 103 timezone: Europe/London properties: activity: $ref: '#/components/schemas/AudienceActivity' description: Fans who wrote to a creator recently. asOf: anyOf: - type: string - type: 'null' description: When the activity figures were computed (UTC). fans: $ref: '#/components/schemas/AudienceFans' renewal: $ref: '#/components/schemas/AudienceRenewal' description: Auto-renew among active fans. retention: $ref: '#/components/schemas/AudienceRetention' description: >- Week-over-week: of the fans who wrote in one week, how many wrote again the next. spendBands: description: Fans by lifetime spend, every band listed. items: $ref: '#/components/schemas/SpendBand' type: array timezone: type: string required: - asOf - timezone - fans - renewal - spendBands - activity - retention title: AudienceReport type: object Error: properties: error: properties: code: description: Stable, machine-readable error code. type: string message: description: What went wrong, in a sentence for a person. type: string requestId: description: >- The id of this request (also in the `X-Request-Id` header). Quote it to support. type: string required: - code - message - requestId type: object required: - error type: object AudienceActivity: properties: last30Days: description: Fans who wrote in the last 30 days. type: integer last7Days: description: Fans who wrote at least once in the last 7 days (today included). type: integer last90Days: description: Fans who wrote in the last 90 days. type: integer required: - last7Days - last30Days - last90Days title: AudienceActivity type: object AudienceFans: properties: active: description: Fans with an active subscription (as last reported by OnlyFans). type: integer expired: description: Fans whose subscription ended. type: integer spenders: description: Fans who have paid anything. type: integer total: description: All fans. type: integer unknown: description: Fans whose subscription state OnlyFans has not reported yet. type: integer required: - total - active - expired - unknown - spenders title: AudienceFans type: object AudienceRenewal: properties: 'off': description: >- Active fans with auto-renew off: they leave when the period ends unless they renew. type: integer 'on': description: Active fans with auto-renew on. type: integer required: - 'on' - 'off' title: AudienceRenewal type: object AudienceRetention: properties: currentEnd: description: Last day of the later week. type: string currentStart: description: First day of the later week. type: string previousEnd: description: Last day of the earlier week. type: string previousFans: description: Fans who wrote in the earlier week. type: integer previousStart: description: First day of the earlier week (`YYYY-MM-DD`). type: string rate: anyOf: - type: number - type: 'null' description: >- `retainedFans / previousFans`, 0 to 1. `null` when nobody wrote in the earlier week. retainedFans: description: Of those, how many wrote again in the later week. type: integer required: - previousStart - previousEnd - currentStart - currentEnd - previousFans - retainedFans - rate title: AudienceRetention type: object SpendBand: properties: band: description: >- Lifetime spend in US dollars: nothing, under $50, $50 to under $200, $200 or more. enum: - none - under_50 - 50_to_200 - 200_plus type: string fans: description: Fans in this band. type: integer required: - band - fans title: SpendBand type: object headers: X-RateLimit-Limit: description: >- Requests allowed in the current window of the tightest limit this request counted against. example: 120 schema: type: integer X-RateLimit-Remaining: description: Requests left in that window. example: 117 schema: type: integer X-RateLimit-Reset: description: When that window resets, as Unix epoch seconds. example: 1790431380 schema: type: integer X-Request-Id: description: >- The id of this request. Your own `X-Request-Id` (8 to 64 letters, digits or `-`) is echoed back; otherwise OnlyX creates one. Also in every error body as `requestId`: quote it to support. example: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: type: string WWW-Authenticate: description: >- The authentication challenge (RFC 6750), for example `Bearer error="insufficient_scope", scope="messages:send"`. schema: type: string Retry-After: description: Seconds to wait before trying again. example: 12 schema: type: integer responses: Unauthorized: content: application/json: examples: INVALID_API_KEY: summary: INVALID_API_KEY value: error: code: INVALID_API_KEY message: The API key is invalid, expired or revoked. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 INVALID_TOKEN: summary: INVALID_TOKEN value: error: code: INVALID_TOKEN message: The access token is invalid, expired or revoked. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 UNAUTHORIZED: summary: UNAUTHORIZED value: error: code: UNAUTHORIZED message: >- Authentication required. Send your API key as `Authorization: Bearer onx_sk_…`. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- No credential was sent (`UNAUTHORIZED`), or it is invalid, expired or revoked (`INVALID_API_KEY` for API keys, `INVALID_TOKEN` for OAuth access tokens: refresh the token or reconnect the app). Too many failed attempts from one address with credentials OnlyX never issued are answered `429 RATE_LIMITED` instead. headers: WWW-Authenticate: $ref: '#/components/headers/WWW-Authenticate' X-Request-Id: $ref: '#/components/headers/X-Request-Id' RateLimited: content: application/json: examples: RATE_LIMITED: summary: RATE_LIMITED value: error: code: RATE_LIMITED message: Too many requests. Try again in 12 seconds. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Over a rate limit (`RATE_LIMITED`). Wait `Retry-After` seconds, then retry — with the same `Idempotency-Key` for a write. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' InternalError: content: application/json: examples: INTERNAL_ERROR: summary: INTERNAL_ERROR value: error: code: INTERNAL_ERROR message: Something went wrong on our side. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Something went wrong on OnlyX's side (`INTERNAL_ERROR`). Retry with backoff (reuse the `Idempotency-Key` for a write); quote `requestId` to support if it persists. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' securitySchemes: bearerAuth: bearerFormat: onx_sk_… API key or onx_at_… access token description: >- An API key (`onx_sk_…`) created in OnlyX under Settings → API & MCP, or an OAuth access token (`onx_at_…`) issued to a connected app. Send it as `Authorization: Bearer `. API keys may also be sent as `X-API-Key: `. scheme: bearer type: http ````