Sign in

v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Analytics

List Pack formula analytics

Returns analytics data for Pack formulas.

get/analytics/packs/{packId}/formulas

Path parameters

packIdinteger required

ID of a Pack

Query parameters

packFormulaNamesstring[]

A list of Pack formula names (case-sensitive) for which to retrieve analytics.

packFormulaTypesPackFormulaType[]

A list of Pack formula types corresponding to the packFormulaNames. If specified, this must have the same length as packFormulaNames.

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' | 'formulaName' | 'formulaType' | 'formulaInvocations' | 'medianLatencyMs' | 'medianResponseSizeBytes' | 'errors' | 'docsActivelyUsing' | 'docsActivelyUsing7Day' | 'docsActivelyUsing30Day' | 'docsActivelyUsing90Day' | 'docsActivelyUsingAllTime' | 'workspacesActivelyUsing' | 'workspacesActivelyUsing7Day' | 'workspacesActivelyUsing30Day' | 'workspacesActivelyUsing90Day' | 'workspacesActivelyUsingAllTime'

Determines how the Pack formula analytics returned are sorted.

Use this parameter to order the Pack formula 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

Response of Superhuman Pack formula 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": [
    {
      "formula": {
        "name": "SquareRoot"
      },
      "metrics": [
        {
          "date": "2020-09-02",
          "formulaInvocations": 123,
          "errors": 5,
          "medianLatencyMs": 500,
          "medianResponseSizeBytes": 300,
          "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/:packId/formulas?pageToken=xyz"
}