> ## 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. # Campaign summary metrics > Return aggregated lifetime metrics for a campaign. ## OpenAPI ````yaml /openapi/openapi-advertising.json get /advertising/api/v1/reporting/campaigns/{campaign_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/reporting/campaigns/{campaign_id}/summary: get: tags: - Ad Reporting summary: Campaign summary metrics description: Return aggregated lifetime metrics for a campaign. operationId: apps_advertising_api_reporting_campaign_summary parameters: - in: path name: campaign_id schema: description: UUID of the campaign. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Campaign Id type: string required: true description: UUID of the campaign. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CampaignSummaryResponse' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: CampaignSummaryResponse: examples: - campaign_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 campaign_name: Summer Snacks Promo status: active totals: clicks: 5780 ctr: '1.50' effective_cpc: '0.50' effective_cpm: '7.51' impressions: 385000 spend: '2890.00' properties: campaign_id: description: UUID of the campaign. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Campaign Id type: string campaign_name: description: Name of the campaign. title: Campaign Name type: string status: $ref: '#/components/schemas/CampaignStatusEnum' description: Current campaign status. totals: $ref: '#/components/schemas/SummaryTotals' description: Lifetime aggregated totals. required: - campaign_id - campaign_name - status - totals title: CampaignSummaryResponse type: object CampaignStatusEnum: description: Mirror of ``apps.advertising.models.CampaignStatus``. enum: - draft - active - paused - completed - archived title: CampaignStatusEnum type: string SummaryTotals: examples: - clicks: 5780 ctr: '1.50' effective_cpc: '0.50' effective_cpm: '7.51' impressions: 385000 spend: '2890.00' properties: impressions: description: Total impressions. title: Impressions type: integer clicks: description: Total clicks. title: Clicks type: integer spend: description: Total spend in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Spend type: string ctr: description: Click-through rate as a percentage. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Ctr type: string effective_cpc: description: Effective cost per click in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Effective Cpc type: string effective_cpm: description: Effective cost per mille in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Effective Cpm type: string required: - impressions - clicks - spend - ctr - effective_cpc - effective_cpm title: SummaryTotals type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````