Sign in
Analytics

List doc analytics

Returns analytics data for available docs per day.

get/analytics/docs

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/analytics/docs
  • Auth: HTTP bearer

Query parameters

docIdsstring[]

List of docIds to fetch.

workspaceIdstring

ID of the workspace.

querystring

Search term used to filter down results.

isPublishedboolean

Limit results to only published items.

sinceDatestring date

Limit results to activity on or after this date.

untilDatestring date

Limit results to activity on or before this date.

scale'daily' | 'cumulative'

Quantization period over which to view analytics.

Quantization period over which to view analytics. Defaults to daily.

pageTokenstring

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

orderBy'date' | 'docId' | 'title' | 'createdAt' | 'publishedAt' | 'likes' | 'copies' | 'views' | 'sessionsDesktop' | 'sessionsMobile' | 'sessionsOther' | 'totalSessions' | 'aiCreditsChat' | 'aiCreditsBlock' | 'aiCreditsColumn' | 'aiCreditsAssistant' | 'aiCreditsReviewer' | 'aiCredits'

Determines how the Doc analytics returned are sorted.

Use this parameter to order the doc analytics returned.

direction'ascending' | 'descending'

Direction of a sort for a table or view.

Direction to sort results in.

limitinteger

Maximum number of results to return in this query.

Response

List of document analytics.

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": [
    {
      "doc": {
        "id": "AbCDeFGH",
        "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH",
        "browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH",
        "title": "Cool Geometry Formulas",
        "icon": {
          "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
        },
        "createdAt": "2022-04-11T00:18:57.946Z",
        "publishedAt": "2022-04-12T00:18:57.946Z"
      },
      "metrics": [
        {
          "date": "2020-09-02",
          "views": 980,
          "copies": 24,
          "likes": 342,
          "sessionsMobile": 530,
          "sessionsDesktop": 212,
          "sessionsOther": 10,
          "totalSessions": 1000,
          "aiCreditsChat": 10,
          "aiCreditsBlock": 10,
          "aiCreditsColumn": 10,
          "aiCreditsAssistant": 10,
          "aiCreditsReviewer": 10,
          "aiCredits": 50
        }
      ]
    }
  ],
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/analytics/docs?pageToken=xyz"
}

Changes

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