> ## Documentation Index > Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the affiliate performance figures > The overview's whole measurement surface in one read: the click, signup, conversion and earnings funnel over a window with each step against the equally long window before it; the rates over those steps; lifetime gross, clawed-back and net commission; where the referral roster stands; when pending commission matures; and what the next monthly payout run would send. A rate whose denominator is too small to state honestly comes back null rather than as a number nobody should act on. ## OpenAPI ````yaml /openapi.json get /affiliate/performance/ openapi: 3.1.0 info: contact: email: support@getoneprofile.ai name: Oneprofile Support description: >- REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started. termsOfService: https://www.getoneprofile.ai/terms title: API Reference | Oneprofile version: '0.0' servers: - url: https://api.getoneprofile.ai security: [] tags: - description: >- The Getting started checklist: a workspace's progress through the six steps from its first people search to its first launched sequence. name: onboarding - description: Sender profiles, connected mailboxes, tags, and the Google connect flow. name: senders - description: The workspace do-not-contact list, enforced before every send. name: suppression - description: 'Sequence authoring: the graph, the table-backed audience, previews.' name: sequences - description: >- The LinkedIn channel: connecting an account to a sender, its safety limits and history, and the protocol the browser extension speaks. name: linkedin - description: 'The unified outreach inbox: threads, replies, labels, events.' name: inbox - description: 'The AI reply layer: workspace settings, drafts, and approval.' name: inbox-ai - description: Notification rules, per-user preferences, and the Slack connection. name: notifications - description: Endpoints for seeing all available integration types. name: integration-types - description: Endpoints for creating and managing integrations. name: integrations - description: Endpoints for the generic OAuth install/claim app-listings engine. name: app-listings - description: Endpoints for creating and managing API keys. name: apikey - description: Endpoints for managing billing and subscription information. name: billing - description: Endpoints for creating and managing tables. name: tables - description: Endpoints for table columns, formula previews, and on-demand column runs. name: table-columns - description: Endpoints for table rows and manual cell edits. name: table-rows - description: Endpoints for observing and cancelling table recompute runs. name: table-runs - description: >- Endpoints for org-shared per-column display preferences: hidden, pinned, width, and colour tint. name: table-ui-prefs - description: >- Endpoints for the org-shared names given to the column tint palette: what this organisation calls each colour. Org-level, not per-table. name: table-column-color-labels - description: >- Endpoints for the enrichment action catalog, model list, presets, draft generation, and saved agents. name: table-enrichments - description: >- Endpoints for teaching a saved agent from example rows: training sessions, per-row feedback, and the proposed prompt to approve. name: agent-training - description: >- The durable audit trail of a table's enrichment actions: configured, edited, run, cancelled, and settled cost. name: table-enrichment-audit-logs - description: Endpoints for saving and applying column templates. name: table-templates - description: Server-sent change feed for a table's grid. name: table-events - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.' name: table-views - description: >- The per-table AI Assistant: named conversations, the column suggestions a build turn produces, and the questions an analyze turn answers. name: table-assistant - description: >- Endpoints for PER-USER table preferences: favourites and recently opened. Unlike the rest of the table surface these are personal, so two members of one organisation legitimately see different answers. name: table-user-prefs - description: >- Endpoints for building a table from an uploaded CSV: upload and preview the inferred columns, commit the reviewed mapping, then poll the row load. name: table-imports - description: Endpoint for downloading a table's rows as CSV. name: table-export - description: >- Endpoints for the integration a table imports from: attach and preview it, promote imported fields into columns, and run the import on demand. name: table-sources - description: >- Endpoints for a table's recurring import cadence: set it, pause it, and read the next fire times. name: table-schedules - description: >- Endpoints for pushing a table's rows out to a connected integration: list writable destinations, derive their write capabilities, and map export columns. name: table-writeback - description: >- Endpoints backing a lookup column's setup: the connections whose records a column could read, and the identity fields one record type can be looked up by. name: table-integration-lookup - description: >- Endpoints for sourcing leads from the lead database: count and preview matches, land them in a table, and keep saved searches. Alongside people and company searches, leads can be sourced from buying signals — what a company or person just did — with a catalogue endpoint behind the picker that builds them. name: find-leads - description: >- Endpoints for discovering a domain's subdomains from public certificate logs and landing the results in a table. name: find-subdomains - description: Endpoints for the credit balance meter and usage reporting. name: credits - description: >- Endpoints for the workspace referral program: the shareable link, the friends who joined through it, and claiming a code after signup. name: referral - description: >- Endpoints for the affiliate program's own dashboard: enrolling and claiming a code, the summary, stats and activity feed, the commission ledger, and identity verification and payouts. name: affiliate - description: >- Endpoints for the design partner program's customer surface: whether this workspace is a design partner, the badges its feedback has earned, and sending and reading that feedback. name: design-partner - description: >- Endpoints for the org-level AI business context — company description, ideal customer profile, buyer personas, interest signals and social proof — plus domain-based generation and the reference documents whose summaries ride alongside those fields. name: ai-context - description: >- Endpoints for the signed-in user's Google Drive connection: starting and finishing the OAuth grant, checking or dropping it, and minting the short-lived token the Google Picker needs. name: google-drive paths: /affiliate/performance/: get: tags: - affiliate summary: Get the affiliate performance figures description: >- The overview's whole measurement surface in one read: the click, signup, conversion and earnings funnel over a window with each step against the equally long window before it; the rates over those steps; lifetime gross, clawed-back and net commission; where the referral roster stands; when pending commission matures; and what the next monthly payout run would send. A rate whose denominator is too small to state honestly comes back null rather than as a number nobody should act on. operationId: get_affiliate_performance parameters: - description: The window these figures cover. in: query name: days required: false schema: default: 30 description: The window these figures cover. maximum: 365 minimum: 1 title: Days type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AffiliatePerformanceReadSchema' description: Successful Response '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' description: Invalid request made to the API. '500': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Internal server error. '502': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Bad gateway error. '503': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Service unavailable. security: - APIKeyHeader: [] - HTTPBearer: [] components: schemas: AffiliatePerformanceReadSchema: description: Everything the affiliate overview measures over one window. properties: active_count: description: Referrals still inside their commission window. title: Active Count type: integer average_commission_cents: anyOf: - type: integer - type: 'null' description: Lifetime gross commission per paying referral. Null with none yet. title: Average Commission Cents clears_minimum_on: anyOf: - format: date type: string - type: 'null' description: >- The day the payable balance first clears the payout minimum on that schedule. Null when it already has, or when it never does. title: Clears Minimum On clicks: $ref: '#/components/schemas/AffiliateTrendReadSchema' conversion_rate: anyOf: - type: number - type: 'null' description: >- Paying referrals per signup, lifetime, 0-1. Null below the honesty floor. title: Conversion Rate conversions: $ref: '#/components/schemas/AffiliateTrendReadSchema' days: description: The window length these figures cover. title: Days type: integer earned_cents: $ref: '#/components/schemas/AffiliateTrendReadSchema' epc_cents: anyOf: - type: integer - type: 'null' description: >- Commission earned per click over the window. Null below the honesty floor. title: Epc Cents held_cents: description: >- Money in a payout waiting on human review. Still counted in the available balance until it is released. title: Held Cents type: integer last_commission_at: anyOf: - format: date-time type: string - type: 'null' title: Last Commission At last_conversion_at: anyOf: - format: date-time type: string - type: 'null' title: Last Conversion At last_signup_at: anyOf: - format: date-time type: string - type: 'null' title: Last Signup At lifetime_clawed_back_cents: description: What refunds and disputes took back, as a positive magnitude. title: Lifetime Clawed Back Cents type: integer lifetime_gross_cents: title: Lifetime Gross Cents type: integer lifetime_net_cents: title: Lifetime Net Cents type: integer never_paid_count: description: Referrals that have not started a paid plan. title: Never Paid Count type: integer next_payout_blocker: anyOf: - type: string - type: 'null' description: >- When blocked, which gate: identity_not_verified, no_payout_email or destination_hold. title: Next Payout Blocker next_payout_cents: description: >- What that run would send on today's numbers plus what matures before it. title: Next Payout Cents type: integer next_payout_on: description: The date of the next monthly payout run. format: date title: Next Payout On type: string next_payout_status: $ref: '#/components/schemas/AffiliateNextPayoutStatus' description: >- Whether that run will actually send anything: scheduled, below the minimum, blocked on a step the affiliate can take, under human review, paused program-wide, or unavailable to this account. signup_rate: anyOf: - type: number - type: 'null' description: >- Signups per click over the window, 0-1. Null when there were too few clicks for the figure to mean anything. title: Signup Rate signups: $ref: '#/components/schemas/AffiliateTrendReadSchema' upcoming_maturities: description: The next days pending commission becomes payable on, soonest first. items: $ref: '#/components/schemas/AffiliateMaturityReadSchema' title: Upcoming Maturities type: array window_closed_count: description: Referrals whose commission window has ended. title: Window Closed Count type: integer required: - days - clicks - signups - conversions - earned_cents - signup_rate - conversion_rate - epc_cents - average_commission_cents - lifetime_gross_cents - lifetime_clawed_back_cents - lifetime_net_cents - never_paid_count - active_count - window_closed_count - upcoming_maturities - clears_minimum_on - next_payout_on - next_payout_cents - next_payout_status - next_payout_blocker - held_cents - last_signup_at - last_conversion_at - last_commission_at title: AffiliatePerformanceReadSchema type: object UnauthorizedResponse: properties: detail: description: The detail of why the request is unauthorized. title: Detail type: string required: - detail title: UnauthorizedResponse type: object ForbiddenResponse: properties: detail: description: The detail of why the request is forbidden. title: Detail type: string required: - detail title: ForbiddenResponse type: object UnprocessableEntityResponse: properties: detail: description: >- The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message. title: Detail type: string issues: description: >- The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message. items: $ref: '#/components/schemas/UnprocessableEntityIssue' title: Issues type: array required: - detail - issues title: UnprocessableEntityResponse type: object ServerErrorResponse: properties: detail: description: The detail of why the server returned an error. title: Detail type: string required: - detail title: ServerErrorResponse type: object AffiliateTrendReadSchema: description: One metric over a window, against the window immediately before it. properties: current: title: Current type: integer previous: title: Previous type: integer required: - current - previous title: AffiliateTrendReadSchema type: object AffiliateNextPayoutStatus: description: >- What the next monthly run will do with this affiliate's balance. Derived from the same gates the payout engine applies, so the sentence the dashboard prints and the decision the run makes cannot disagree. Every "your payout goes out on the 1st" used to be unconditional, which made it false for a first payout (held for a human), a blocked affiliate (no identity check, no PayPal address, a fresh address inside its hold), a suspended or banned account, a balance under the minimum, and the whole period the program ships with payouts switched off. enum: - paused - unavailable - under_review - blocked - below_minimum - scheduled title: AffiliateNextPayoutStatus type: string AffiliateMaturityReadSchema: description: One future day on which pending commission becomes payable. properties: amount_cents: title: Amount Cents type: integer day: format: date title: Day type: string running_available_cents: description: >- The payable balance once this day has matured, absent clawbacks and payouts. title: Running Available Cents type: integer required: - day - amount_cents - running_available_cents title: AffiliateMaturityReadSchema type: object UnprocessableEntityIssue: properties: input: anyOf: - type: string - type: integer - type: number - type: boolean - items: {} type: array - additionalProperties: true type: object description: The user's input that caused the error. title: Input loc: description: >- The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present. items: type: string title: Loc type: array msg: description: The message of the error. The error message to show to the user. title: Msg type: string type: description: >- The type of the error. Useful for frontend code to handle different types of errors. title: Type type: string required: - loc - msg - type - input title: UnprocessableEntityIssue type: object securitySchemes: APIKeyHeader: in: header name: X-API-Key type: apiKey HTTPBearer: scheme: bearer type: http ````