For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /gammas/{gammaId}/analytics/viewers

Returns paginated per-viewer engagement data for a Gamma. Requires at least edit permission; manage permission returns all viewers, edit permission returns only the API key owner's row.

Retrieve paginated per-viewer engagement rows for a single Gamma.

Get per-viewer analytics

get

Returns paginated per-viewer engagement data for a Gamma. Requires at least edit permission on the Gamma. When the API key's user has manage permission the list covers all viewers (scope: "all"); otherwise it contains at most that user's own row (scope: "self"). Viewers are capped at 500. Data is eventually consistent (~hourly).

Authorizations
X-API-KEYstringRequired

API key for authentication

Path parameters
gammaIdstringRequired

The ID of the Gamma — accepts a gamma (file) ID or a page/doc ID (the ID in a gamma.app/docs/ URL).

Example: abc123xyz
Query parameters
limitnumber · min: 1 · max: 50Optional

Maximum number of viewers to return

Example: 25
afterstringOptional

Cursor for pagination (from a previous response's nextCursor)

Example: eyJpZCI6IjEyMyJ9
sortDirectionstring · enumOptional

Sort direction, applied to the viewer's most recent open time

Example: descPossible values:
Responses
200

Viewer analytics retrieved successfully

application/json
scopestring · enumRequired

Which viewers the rows cover: all — every viewer of the Gamma (the API key's user has manage permission); self — at most the API key user's own row (edit permission).

Example: allPossible values:
gammaIdstringRequired

The Gamma (file) ID

Example: abc123xyz
hasMorebooleanRequired

Whether more viewers exist beyond this page

Example: true
nextCursorstring · nullableRequired

Cursor for fetching the next page (null if no more results)

Example: eyJpZCI6IjQ1NiJ9
get/v1.0/gammas/{gammaId}/analytics/viewers

Requires at least edit permission on the Gamma. The response scope field is all when the API key owner has manage permission (rows cover every viewer) or self when they have edit permission only (at most that user's own row). Results are capped at 500 viewers total. Use limit (1-50), after, and sortDirection to paginate. Metrics are eventually consistent and update about hourly.

Last updated

Was this helpful?