GET /gammas/{gammaId}/analytics/cards

Returns per-card engagement data for a Gamma: card name, position, view time in seconds, and viewer reach as a percentage for every card.

Retrieve per-card engagement stats for a single Gamma.

Get per-card analytics

get

Returns per-card engagement data for a Gamma: view time (absolute seconds) and viewer reach (percentage) per card. Requires at least edit permission on the Gamma. When the API key's user has manage permission the data covers all viewers (scope: "all"); otherwise it covers only that user's own activity (scope: "self"). Data is eventually consistent (~hourly).

Authorizations

api-key

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

Responses

200

Card analytics retrieved successfully

application/json

scopestring · enumRequired

Which activity the card stats cover: all — every viewer of the Gamma (the API key's user has manage permission); self — only the API key user's own activity (edit permission).

Example: allPossible values:

gammaIdstringRequired

The Gamma (file) ID

Example: abc123xyz

uniqueViewersnumberRequired

Total unique viewers for the Gamma

Example: 128

uniqueEditorsnumberRequired

Total unique editors

Example: 3

cardCountnumberRequired

Number of cards in the Gamma

Example: 12

400

Invalid request parameters

401

Invalid or missing API key

403

Access denied — at least edit permission required

404

Gamma not found

get/v1.0/gammas/{gammaId}/analytics/cards

HTTPcURLJavaScriptPython

GET /v1.0/gammas/{gammaId}/analytics/cards HTTP/1.1
Host: public-api.gamma.app
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "scope": "all",
  "gammaId": "abc123xyz",
  "uniqueViewers": 128,
  "uniqueEditors": 3,
  "cardCount": 12,
  "cards": [
    {
      "cardId": "card_abc123",
      "cardName": "Introduction",
      "cardPosition": 1,
      "viewTimeSeconds": 245,
      "viewersPercent": 87
    }
  ]
}

Accepts either the API file ID or the doc ID from a gamma.app/docs/... URL. Requires at least edit permission on the Gamma. The response scope field is all when the API key owner has manage permission (stats cover every viewer) or self when they have edit permission only (stats cover that user's activity). The cards array includes every card in the Gamma, ordered by cardPosition (1-indexed). Each row has cardName (the card title, or null if none) and zeroed viewTimeSeconds / viewersPercent when there is no recorded activity. Metrics are eventually consistent and update about hourly.

Related

• GET /gammas/{gammaId}/analytics for doc-level totals and daily breakdown
• GET /gammas/{gammaId}/analytics/viewers for per-viewer engagement rows
• GET /gammas/{gammaId} for title, thumbnail, and URL metadata
• Error codes for authentication and permission failures