> ## 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. # Period summary for BI integration > The same period-summary payload the Exports tab's PDF report renders, as JSON: resolves / page-visit totals with period-over-period deltas, conversion rate, top GTINs, and country breakdown. Caller must be a member of ``organization_id`` (or hold an API key scoped to it) or a 404 is returned. ## OpenAPI ````yaml /openapi/openapi-analytics.json get /analytics/api/v1/exports/overview openapi: 3.1.0 info: title: Analytics API version: 1.0.0 description: > Pre-aggregated traffic metrics for the requesting organization at every level of the brand → product → trade-item hierarchy. Returns a stacked time series with breadcrumbs and summary totals, ready to chart directly. Also includes the Exports endpoints: a period-summary payload and paginated raw scan events, for customers integrating with their own BI tools. Scoped to organizations you are a member of; an org-scoped API key reaches exactly its own organization. ## 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: [] externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /analytics/api/v1/exports/overview: get: tags: - Exports summary: Period summary for BI integration description: >- The same period-summary payload the Exports tab's PDF report renders, as JSON: resolves / page-visit totals with period-over-period deltas, conversion rate, top GTINs, and country breakdown. Caller must be a member of ``organization_id`` (or hold an API key scoped to it) or a 404 is returned. operationId: apps_analytics_api_exports_get_overview_export parameters: - in: query name: organization_id schema: description: UUID of the organization to query (caller must be a member). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: UUID of the organization to query (caller must be a member). - in: query name: days schema: default: 30 description: >- Window size in days, ending now. Clamped server-side to the organization's actual raw-event retention — the response may cover a shorter window than requested. maximum: 365 minimum: 1 title: Days type: integer required: false description: >- Window size in days, ending now. Clamped server-side to the organization's actual raw-event retention — the response may cover a shorter window than requested. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OverviewOut' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '404': description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '405': description: Method Not Allowed content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '422': description: Unprocessable Content content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - CookieGatedSessionAuth: [] components: schemas: OverviewOut: description: >- Period summary — the same payload the Overview tab and PDF export render. Backs ``GET /exports/overview``, the JSON counterpart to the Exports tab's PDF download, for customers integrating with their own BI tools. examples: - conversion: label: of resolves rate_pct: 25.9 countries: - code: US count: 1100 country_count: 4 days: 30 page_visits: delta_pct: 7.6 previous_total: 290 total: 312 period: end: '2026-09-07T00:00:00Z' start: '2026-08-08T00:00:00Z' resolves: delta_pct: 22.9 previous_total: 980 total: 1204 top_gtins: - gtin: '00000000000017' name: Cereal resolves: 340 properties: days: description: >- Window size in days actually used (the requested value, clamped if needed). title: Days type: integer period: $ref: '#/components/schemas/PeriodOut' description: Window covered by this summary. resolves: $ref: '#/components/schemas/MetricDeltaOut' description: Total resolves this period vs. the previous period. page_visits: $ref: '#/components/schemas/MetricDeltaOut' description: Total page visits this period vs. the previous period. conversion: $ref: '#/components/schemas/ConversionOut' description: Resolve-to-visit conversion rate. top_gtins: description: Top 5 GTINs by resolve volume. items: $ref: '#/components/schemas/TopGtinOut' title: Top Gtins type: array countries: description: Resolve counts by country, descending. items: $ref: '#/components/schemas/CountryCountOut' title: Countries type: array country_count: description: Number of distinct countries with at least one resolve. minimum: 0 title: Country Count type: integer required: - days - period - resolves - page_visits - conversion - top_gtins - countries - country_count title: OverviewOut type: object ErrorOut: description: |- RFC 9457 Problem Details response. All API errors are returned in this format with Content-Type: application/problem+json. examples: - detail: The requested resource was not found. error_code: not_found retryable: false status: 404 timestamp: '2026-03-31T12:00:00+00:00' title: Not Found type: https://closient.com/docs/errors/not_found - detail: Validation error. details: - loc: - body - name msg: Field required type: missing error_code: validation_error retryable: false status: 422 timestamp: '2026-03-31T12:00:00+00:00' title: Validation Error type: https://closient.com/docs/errors/validation_error - detail: Rate limit exceeded. Please try again later. error_code: rate_limited retry_after: 31 retryable: true status: 429 timestamp: '2026-03-31T12:00:00+00:00' title: Rate Limited type: https://closient.com/docs/errors/rate_limited properties: type: description: URI reference identifying the error type. title: Type type: string title: description: Short human-readable summary of the error. title: Title type: string status: description: HTTP status code. title: Status type: integer detail: description: Human-readable explanation of this specific occurrence. title: Detail type: string error_code: description: Machine-readable error code (e.g. not_found, unauthorized). title: Error Code type: string retryable: default: false description: Whether retrying the same request can succeed. title: Retryable type: boolean timestamp: description: ISO 8601 timestamp of when the error occurred. title: Timestamp type: string retry_after: anyOf: - type: integer - type: 'null' description: Seconds to wait before retrying (when applicable). title: Retry After owner_action_required: anyOf: - type: boolean - type: 'null' description: Whether the error requires account owner intervention. title: Owner Action Required details: description: Additional context (validation errors, etc.). title: Details required: - type - title - status - detail - error_code - timestamp title: ErrorOut type: object PeriodOut: description: Inclusive start / exclusive end of the requested time window. examples: - end: '2026-07-08T00:00:00Z' start: '2026-07-01T00:00:00Z' properties: start: description: Window start (UTC). format: date-time title: Start type: string end: description: Window end (UTC, exclusive). format: date-time title: End type: string required: - start - end title: PeriodOut type: object MetricDeltaOut: description: A period total plus its comparison to the immediately preceding period. examples: - delta_pct: 22.9 previous_total: 980 total: 1204 properties: total: description: Total for the requested period. minimum: 0 title: Total type: integer previous_total: description: Total for the immediately preceding equal-length period. minimum: 0 title: Previous Total type: integer delta_pct: anyOf: - type: number - type: 'null' description: >- Percent change vs. the previous period. ``null`` when there is no prior-period baseline. title: Delta Pct required: - total - previous_total title: MetricDeltaOut type: object ConversionOut: description: Resolve-to-visit conversion rate for the period. examples: - label: of resolves rate_pct: 25.9 properties: rate_pct: anyOf: - type: number - type: 'null' description: >- Percent of resolves that landed on a hosted page. ``null`` when there were no resolves. title: Rate Pct label: description: Denominator label — always 'of resolves'. title: Label type: string required: - label title: ConversionOut type: object TopGtinOut: description: One row in the Top-GTINs-by-resolves table. examples: - gtin: '00000000000017' name: Cereal resolves: 340 properties: gtin: description: GTIN-14 of the product. title: Gtin type: string name: description: Product name. title: Name type: string resolves: description: Resolve count for this GTIN within the period. minimum: 0 title: Resolves type: integer required: - gtin - name - resolves title: TopGtinOut type: object CountryCountOut: description: Resolve count for one ISO 3166-1 alpha-2 country within the period. examples: - code: US count: 1100 properties: code: description: ISO 3166-1 alpha-2 country code. title: Code type: string count: description: Resolve count for this country within the period. minimum: 0 title: Count type: integer required: - code - count title: CountryCountOut type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer CookieGatedSessionAuth: type: apiKey in: cookie name: sessionid ````