> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # Revenue share summary > Get total earned, paid, and pending revenue share balance for an organization. ## OpenAPI ````yaml /openapi/openapi-advertising.json get /advertising/api/v1/revenue-share/{organization_id}/summary openapi: 3.1.0 info: title: Advertising API version: 1.0.0 description: > Ad campaigns, impressions, revenue share, and reporting. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Ads description: Record ad clicks and impression events. - name: Ad Reporting description: Campaign performance metrics and analytics. - name: Revenue Share description: Revenue share configuration and payouts. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /advertising/api/v1/revenue-share/{organization_id}/summary: get: tags: - Revenue Share summary: Revenue share summary description: >- Get total earned, paid, and pending revenue share balance for an organization. operationId: apps_advertising_api_revenue_share_revenue_share_summary parameters: - in: path name: organization_id schema: description: UUID of the organization. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: UUID of the organization. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RevenueShareSummaryOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: RevenueShareSummaryOut: examples: - active_locations: 12 organization_id: b2c3d4e5-f678-9012-abcd-ef2345678901 pending_balance: '4100.00' total_earned: '18500.00' total_paid: '14400.00' properties: organization_id: description: UUID of the organization. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string total_earned: description: Total retailer share across all periods in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Total Earned type: string total_paid: description: Total amount already paid in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Total Paid type: string pending_balance: description: Outstanding balance to be paid in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Pending Balance type: string active_locations: description: Number of active locations for this organization. title: Active Locations type: integer required: - organization_id - total_earned - total_paid - pending_balance - active_locations title: RevenueShareSummaryOut type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````