> ## 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. # Analytics overview (current vs previous period) > Aggregate analytics for one or more projects over a date range: post count, impressions, engagement rate, follower growth, and posting activity — each compared against the immediately preceding period of equal length. Pass a comma-separated `projectId` to aggregate multiple projects. Defaults to the last 30 days. Required scope: `analytics:read`. ## OpenAPI ````yaml /openapi/v1.yaml get /analytics/overview openapi: 3.1.0 info: title: Scripe Public API version: '2026-08-01' summary: Read-only access to Scripe workspaces, projects, notes, posts, and sources. description: | The Scripe public API gives integrators stable, versioned read access to a workspace's content surface. Phase 2 ships read endpoints only; write endpoints land in Phase 3. All endpoints (except `/v1/health`) require a Bearer API key. 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: 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/overview: get: tags: - Analytics summary: Analytics overview (current vs previous period) description: | Aggregate analytics for one or more projects over a date range: post count, impressions, engagement rate, follower growth, and posting activity — each compared against the immediately preceding period of equal length. Pass a comma-separated `projectId` to aggregate multiple projects. Defaults to the last 30 days. Required scope: `analytics:read`. operationId: getAnalyticsOverview parameters: - $ref: '#/components/parameters/ScripeApiVersion' - name: projectId in: query required: true description: One project id, or a comma-separated list. schema: type: string example: proj_a1b2c3d4e5f6g7h8 - $ref: '#/components/parameters/DateFrom' - $ref: '#/components/parameters/DateTo' responses: '200': description: Analytics overview. content: application/json: schema: $ref: '#/components/schemas/AnalyticsOverviewResponse' '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-01' 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 schemas: AnalyticsOverviewResponse: type: object required: - data properties: data: $ref: '#/components/schemas/AnalyticsOverview' AnalyticsOverview: type: object required: - posts - impressions - engagement - followers - activity - range properties: posts: type: object required: - current - previous properties: current: type: integer previous: type: integer impressions: type: object required: - current - previous properties: current: type: integer previous: type: integer engagement: type: object required: - current_rate - previous_rate properties: current_rate: type: number previous_rate: type: number followers: type: object required: - current - growth properties: current: type: integer growth: type: integer activity: type: object required: - current_posts_per_week - previous_posts_per_week properties: current_posts_per_week: type: number previous_posts_per_week: type: number range: type: object required: - from - to - days properties: from: type: string format: date-time to: type: string format: date-time days: type: integer 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. 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' 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. ````