> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.scripe.io/llms.txt > Use this file to discover all available pages before exploring further. # Download analytics report (PDF or CSV) > Generate a downloadable PDF or CSV report for one or more projects over a date range. Bundles the same figures as the in-app dashboard export — executive summary, per-author performance, every post in the period (highest-impression first, up to 3,000 rows — a file that hits the cap says so and points at `GET /v1/analytics/posts`, which pages through all of them), daily metrics, and the follower timeline — into a single styled document (PDF) or comma-separated table (CSV). The summary names three click figures the dashboard never adds up: LinkedIn's link clicks on the period's posts (the *Link clicks* KPI card), the workspace's Scripe tracked-link clicks by click date (the conversion funnel's *Tracked link clicks* stage), and LinkedIn's Premium call-to-action clicks. The CSV opens directly in spreadsheet software (UTF-8 BOM, RFC 4180 quoting, one metric per column). A text cell a spreadsheet would evaluate is prefixed with an apostrophe so it is read as text instead of a formula: always when it starts with `=`, and when it starts with `+`, `-`, `@`, a tab or a line break and its first paragraph — everything up to the first blank line — also contains a `(` or `|`. Ordinary prose that merely opens with one of those characters is left byte-for-byte intact, including a `(` or `|` in a later paragraph. The response is a binary file body with a `Content-Disposition: attachment` filename. Pass a comma-separated `projectId` to aggregate multiple projects. If omitted, aggregates across all projects available to the caller in the workspace. Defaults to the last 30 days. Required scope: `analytics:read`. ## OpenAPI ````yaml /openapi/v1.yaml get /analytics/report openapi: 3.1.0 info: title: Scripe Public API version: '2026-08-10' summary: >- Read and write Scripe workspace data — posts, notes, ideas, sources, knowledge, media, analytics, usage, async jobs, and webhooks. description: | The Scripe public API gives integrators stable, versioned access to a workspace's content surface: reads across every resource, synchronous writes (notes, posts, ideas, text sources, media assets), async jobs (post generation, file/URL/YouTube ingest, image and carousel generation), usage meters, and outbound webhooks. All endpoints (except `/v1/health`) require a Bearer token — either a workspace API key (`scripe_sk_*`) or an OAuth 2.1 access token (`scripe_oat_*`). Pin the API version with the `Scripe-Api-Version` request header to opt out of breaking changes. contact: name: Scripe Support url: https://scripe.io/support email: support@scripe.io license: name: Proprietary servers: - url: https://api.scripe.io/v1 description: Production security: - BearerApiKey: [] tags: - name: Health description: Liveness and authenticated key smoke tests. - name: Workspace description: The workspace + principal resolved from your API key. - name: Projects description: Personal-brand, company-page, and amplifier projects. - name: Notes description: Project notes with paired calendar slot. - name: Posts description: Drafts, scheduled, and published LinkedIn posts. - name: Analytics description: Your own LinkedIn analytics and viral-post inspiration search. - name: Sources description: Transcriptions (audio/video sources) with truncated body. - name: Uploads description: >- Pre-signed S3 PUT URLs the customer uploads bytes to before referencing via Sources or Knowledge. - name: Knowledge description: >- Knowledge-base documents indexed for RAG. Async ingest via text, file, URL, or YouTube. - name: Jobs description: >- Async-job lifecycle — submitted via post-generation, knowledge ingest, file source. - name: Calendar description: >- The content calendar — scheduled/planned posts, note slots, idea placements, and the posting-time template. - name: Ideas description: >- The idea board — creative briefs with derived workflow statuses and date-level calendar placement. - name: Media description: >- Media-library search, own-image imports, AI image generation, and full-state media writes onto posts. - name: Settings description: >- Curated project settings, engagement policy, and company pages (read-only over REST). - name: Webhooks description: | Outbound HTTP callbacks. Subscribe an endpoint to one or more event names; we POST a signed JSON payload every time a matching event fires in the workspace. The signing secret is shown once on create and once on rotate — verify the `Webhook-Signature: t=,v1=` header on every delivery. paths: /analytics/report: get: tags: - Analytics summary: Download analytics report (PDF or CSV) description: > Generate a downloadable PDF or CSV report for one or more projects over a date range. Bundles the same figures as the in-app dashboard export — executive summary, per-author performance, every post in the period (highest-impression first, up to 3,000 rows — a file that hits the cap says so and points at `GET /v1/analytics/posts`, which pages through all of them), daily metrics, and the follower timeline — into a single styled document (PDF) or comma-separated table (CSV). The summary names three click figures the dashboard never adds up: LinkedIn's link clicks on the period's posts (the *Link clicks* KPI card), the workspace's Scripe tracked-link clicks by click date (the conversion funnel's *Tracked link clicks* stage), and LinkedIn's Premium call-to-action clicks. The CSV opens directly in spreadsheet software (UTF-8 BOM, RFC 4180 quoting, one metric per column). A text cell a spreadsheet would evaluate is prefixed with an apostrophe so it is read as text instead of a formula: always when it starts with `=`, and when it starts with `+`, `-`, `@`, a tab or a line break and its first paragraph — everything up to the first blank line — also contains a `(` or `|`. Ordinary prose that merely opens with one of those characters is left byte-for-byte intact, including a `(` or `|` in a later paragraph. The response is a binary file body with a `Content-Disposition: attachment` filename. Pass a comma-separated `projectId` to aggregate multiple projects. If omitted, aggregates across all projects available to the caller in the workspace. Defaults to the last 30 days. Required scope: `analytics:read`. operationId: downloadAnalyticsReport parameters: - $ref: '#/components/parameters/ScripeApiVersion' - name: projectId in: query required: false description: >- One project id, or a comma-separated list. If omitted, defaults to all available projects. schema: type: string example: proj_a1b2c3d4e5f6g7h8 - $ref: '#/components/parameters/DateFrom' - $ref: '#/components/parameters/DateTo' - name: currency in: query required: false description: Currency for the Earned Media Value figure. schema: type: string enum: - EUR - USD - GBP default: USD - name: cpm in: query required: false description: > Cost-per-mille rate used to compute Earned Media Value (impressions / 1000 × cpm). Defaults to 35. schema: type: number minimum: 1 default: 35 - name: mode in: query required: false description: Format of the returned report document. schema: type: string enum: - pdf - csv default: pdf responses: '200': description: The analytics report in the requested format. content: application/pdf: schema: type: string format: binary text/csv: schema: type: string '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: ScripeApiVersion: name: Scripe-Api-Version in: header required: false description: | Pin the API version. Format `YYYY-MM-DD`. Omit to receive the currently rolling default. Unknown versions return `400 version_unsupported`. schema: type: string example: '2026-08-10' DateFrom: name: dateFrom in: query required: false description: ISO 8601 or `YYYY-MM-DD` lower bound (inclusive). schema: type: string format: date-time DateTo: name: dateTo in: query required: false description: ISO 8601 or `YYYY-MM-DD` upper bound (inclusive). schema: type: string format: date-time responses: BadRequest: description: Malformed request (bad cursor, bad limit, etc.). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing, malformed, expired, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: Plan not eligible, scope missing, or workspace mismatch. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Resource not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Sliding-window rate limit exceeded. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - error properties: error: type: object required: - code - message - request_id - docs_url properties: code: type: string description: Stable, machine-readable error identifier. example: not_found message: type: string request_id: type: string example: req_a1b2c3d4e5f6 docs_url: type: string format: uri details: description: Optional structured payload — shape varies per code. securitySchemes: BearerApiKey: type: http scheme: bearer bearerFormat: scripe_sk_live_* description: | Pass `Authorization: Bearer scripe_sk_live_<...>` (or `scripe_sk_test_<...>` for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard. The same header also accepts an OAuth 2.1 access token (`scripe_oat_*`); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except `webhooks:manage`, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer `403 scope_missing` to every API key. Operations that name no scope accept any valid token of the workspace. ````