Get analytics metadata

GET

/analytics-metadata

GET

/analytics-metadata

curl -G https://api.postman.com/analytics-metadata \
     -H "x-api-key: <apiKey>" \
     --data-urlencode metrics=active_workspaces,license_consumption

{
  "data": {
    "description": "Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman",
    "resources": [
      {
        "description": "Workspace-level metrics and insights about activities and collaboration patterns",
        "metrics": [
          {
            "description": "List of active workspaces in the selected period based on edits and API requests sent.",
            "metric": "active_workspaces"
          }
        ],
        "resource": "workspace"
      },
      {
        "description": "Team-level metrics and insights on team activity, license consumption, and organizational workspace trends",
        "metrics": [
          {
            "description": "Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats.",
            "metric": "license_consumption"
          }
        ],
        "resource": "team"
      }
    ]
  }
}

Returns a catalog of analytics resources and their corresponding metrics for use with the GET /analytics endpoint. These metrics provide insights on API usage, success, workspace, and team trends in Postman.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

includestringOptional

A comma-separated list of the additional information to include in the response. Accepts the parameters and response values.

When you pass this query parameter and its values, the response provides detailed information, including parameters and response schemas for the given metrics.

A comma-separated list of the additional information to include in the response. Accepts the `parameters` and `response` values. When you pass this query parameter and its values, the response provides detailed information, including parameters and response schemas for the given metrics.

resourcesstringOptional

A comma-separated list of resource types to filter the metrics by. Accepts the user, workspace, team, and ai values.

metricsenumOptional

A comma-separated list of metrics values to use to filter the response.

If you don’t pass this query parameter, then the response returns all metadata for all available metrics.

Response

Successful Response

dataobjectOptional

The Analytics API's metadata information.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error