> ## 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. # Record ad impressions > Batch-record ad impression events for one or more campaigns. ## OpenAPI ````yaml /openapi/openapi-advertising.json post /advertising/api/v1/ads/impressions 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/ads/impressions: post: tags: - Ads summary: Record ad impressions description: Batch-record ad impression events for one or more campaigns. operationId: apps_advertising_api_ads_record_impressions parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchImpressionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BatchImpressionResponse' components: schemas: BatchImpressionRequest: examples: - impressions: - campaign_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 offer_id: f9e8d7c6-b5a4-3210-fedc-ba0987654321 search_query: organic granola bars properties: impressions: description: List of impressions to record. items: $ref: '#/components/schemas/ImpressionRequest' title: Impressions type: array search_query: anyOf: - type: string - type: 'null' description: Search query associated with these impressions. title: Search Query required: - impressions title: BatchImpressionRequest type: object BatchImpressionResponse: examples: - count: 3 success: true properties: success: description: '``true`` when the impression batch was accepted for processing.' title: Success type: boolean count: description: Number of impression events accepted in this batch. title: Count type: integer required: - success - count title: BatchImpressionResponse type: object ImpressionRequest: examples: - campaign_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 offer_id: f9e8d7c6-b5a4-3210-fedc-ba0987654321 properties: campaign_id: description: UUID of the campaign. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Campaign Id type: string offer_id: anyOf: - description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: >- ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ type: string - type: 'null' description: UUID of the offer shown. title: Offer Id required: - campaign_id title: ImpressionRequest type: object ````