Events

A file's readership report

The owner's readership dashboard data. The response shape follows the owner's plan (a tier field says which sections are present). On the Pro plan the response includes a variants array - per-link-variant readership: {uuid, label, sessions, avgTimeMs, revoked, redacted} per variant, label omitted after GDPR redaction. Scope readership:read.

get/api/v1/files/{uuid}/readership

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/files/{uuid}/readership
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://everypage.co/oauth/authorize, token URL https://everypage.co/oauth/token, scopes: readership:read)

Response

Readership report (plan-shaped; variants present on Pro when the file has link variants)

tier'free' | 'basic' | 'pro' required

The owner's plan, which decides which sections are present.

Example response

{
  "file": {
    "shortId": "aB3xY9kQ2mZ7",
    "slug": "2026-pricing",
    "originalName": "proposal.pdf",
    "mimeType": "application/pdf",
    "shareDomain": "docs.example.com",
    "palette": [
      "#1a2b3c"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.