c65a8418f3c8

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Analytics

List page analytics

Returns analytics data for a given doc within the day. This method will return a 401 if the given doc is not in an Enterprise workspace.

get/analytics/docs/{docId}/pages

Path parameters

docIdstring required

ID of the doc.

Query parameters

sinceDatestring date

Limit results to activity on or after this date.

untilDatestring date

Limit results to activity on or before this date.

pageTokenstring

An opaque token used to fetch the next page of results.

limitinteger

Maximum number of results to return in this query.

Response

List of page analytics for the given document.

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "page": {
        "id": "section-IjkLmnO",
        "name": "Launch Status",
        "icon": {
          "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
        }
      },
      "metrics": [
        {
          "date": "2022-06-03",
          "views": 980,
          "sessions": 24,
          "users": 42,
          "averageSecondsViewed": 42,
          "medianSecondsViewed": 42,
          "tabs": 10
        }
      ]
    }
  ],
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/analytics/docs/DOC_ID/pages?pageToken=xyz"
}