Sign in

v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Analytics

List Pack analytics

Returns analytics data for Packs the user can edit.

get/analytics/packs

Query parameters

packIdsinteger[]

Which Pack IDs to fetch.

workspaceIdstring

ID of the workspace.

querystring

Search term used to filter down results.

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' | 'packId' | 'name' | 'createdAt' | 'docInstalls' | 'workspaceInstalls' | 'numFormulaInvocations' | 'numActionInvocations' | 'numSyncInvocations' | 'numMetadataInvocations' | 'docsActivelyUsing' | 'docsActivelyUsing7Day' | 'docsActivelyUsing30Day' | 'docsActivelyUsing90Day' | 'docsActivelyUsingAllTime' | 'workspacesActivelyUsing' | 'workspacesActivelyUsing7Day' | 'workspacesActivelyUsing30Day' | 'workspacesActivelyUsing90Day' | 'workspacesActivelyUsingAllTime' | 'workspacesWithActiveSubscriptions' | 'workspacesWithSuccessfulTrials' | 'revenueUsd'

Determines how the Pack analytics returned are sorted.

Use this parameter to order the Pack analytics returned.

direction'ascending' | 'descending'

Direction of a sort for a table or view.

Direction to sort results in.

isPublishedboolean

Limit results to only published items. If false or unspecified, returns all items including published ones.

limitinteger

Maximum number of results to return in this query.

Response

Response of Superhuman Pack 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": [
    {
      "pack": {
        "id": 1003,
        "name": "Cool Geometry Formulas",
        "createdAt": "2022-04-11T00:18:57.946Z"
      },
      "metrics": [
        {
          "date": "2020-09-02",
          "docInstalls": 100,
          "workspaceInstalls": 10,
          "numFormulaInvocations": 100,
          "numActionInvocations": 100,
          "numSyncInvocations": 100,
          "numMetadataInvocations": 100,
          "docsActivelyUsing": 50,
          "docsActivelyUsing7Day": 100,
          "docsActivelyUsing30Day": 200,
          "docsActivelyUsing90Day": 300,
          "docsActivelyUsingAllTime": 500,
          "workspacesActivelyUsing": 10,
          "workspacesActivelyUsing7Day": 15,
          "workspacesActivelyUsing30Day": 20,
          "workspacesActivelyUsing90Day": 30,
          "workspacesActivelyUsingAllTime": 50
        }
      ]
    }
  ],
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/analytics/packs?pageToken=xyz"
}