Get a document's readership
everypage_get_readershipGet readership metrics for your EveryPage document: views, unique readers, read time, completion rate, countries, and drop-off. Find out if your proposal was read and where readers stopped.
Instructions
Find out who read an EveryPage document and how far they got: views, unique readers, read time, completion rate, countries, where readers dropped off, and per-recipient attribution. Use this to answer questions like "did they read my proposal?" or "where do people stop reading?".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | The document: UUID, short link id, or a pasted share URL. | |
| includePages | No | Also fetch per-page statistics to find the most re-read page. Default true. Requires the Basic plan or higher. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tier | No | The plan that shaped this report; sections above it are absent. | |
| pages | No | ||
| funnel | No | ||
| fileName | No | ||
| fileUuid | Yes | ||
| variants | No | ||
| avgTimeMs | No | ||
| countries | No | ||
| downloads | No | ||
| totalTurns | No | ||
| totalViews | No | ||
| newSessions | No | ||
| medianTimeMs | No | ||
| activeReaders | No | ||
| backTurnShare | No | ||
| totalSessions | No | ||
| biggestDropPct | No | ||
| completionRate | No | ||
| uniqueVisitors | No | ||
| biggestDropPage | No | The page with the steepest fall-off in readers. | |
| uniqueCountries | No | ||
| invitedNotViewed | No | ||
| returningSessions | No |