Get analytics metadata

GET

/analytics-metadata

GET

/analytics-metadata

$ curl https://api.getpostman.com/analytics-metadata \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": {
3     "description": "Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman",
4     "resources": [
5       {
6         "description": "User-level metrics and insights describing activities and engagement within Postman workspaces.",
7         "metrics": [
8           {
9             "description": "Users who used postman at least once.",
10             "metric": "active_users"
11           },
12           {
13             "description": "Users who created, edited or sent requests within an individual workspace.",
14             "metric": "workspace_active_users"
15           }
16         ],
17         "resource": "user"
18       },
19       {
20         "description": "Workspace-level metrics and insights about activities and collaboration patterns",
21         "metrics": [
22           {
23             "description": "Total count of workspace elements (collections, environments, mocks and monitors) over time.",
24             "metric": "elements_in_workspace"
25           },
26           {
27             "description": "List of active workspaces in the selected period based on edits and API requests sent.",
28             "metric": "active_workspaces"
29           },
30           {
31             "description": "Aggregated API call counts across workspaces.",
32             "metric": "api_calls"
33           },
34           {
35             "description": "List of collections that have been edited or used to send API requests.",
36             "metric": "active_collections"
37           },
38           {
39             "description": "Breakdown of API response codes (2xx, 4xx, 5xx) over time.",
40             "metric": "response_status"
41           },
42           {
43             "description": "List of pending workspace invitations including target email addresses and invite timestamps.",
44             "metric": "pending_invites"
45           },
46           {
47             "description": "Identifies partners or users needing attention (e.g., no successful requests or high error rates) for proactive support.",
48             "metric": "needs_attention"
49           },
50           {
51             "description": "Percentage of successful responses (2xx) over time",
52             "metric": "success_rate"
53           },
54           {
55             "description": "Request-level data for individual users including request names, collections, response statuses and timestamps.",
56             "metric": "user_requests"
57           },
58           {
59             "description": "Aggregated error metrics (4xx, 5xx responses) per collection, helping identify collections with the highest error rates.",
60             "metric": "collection_error_aggregate"
61           }
62         ],
63         "resource": "workspace"
64       },
65       {
66         "description": "Team-level metrics and insights on team activity, license consumption, and organizational workspace trends",
67         "metrics": [
68           {
69             "description": "Tracks user progression through the API adoption funnel, showing active users, API users, new API users, successful users, and error-only users. Helps teams understand user onboarding effectiveness and identify users needing support.",
70             "metric": "user_api_journey"
71           },
72           {
73             "description": "Distribution of workspace types (team, private, partner, public) over time.",
74             "metric": "workspace_distribution"
75           },
76           {
77             "description": "Distribution of internal workspaces created into team-shared and private categories.",
78             "metric": "internal_workspace_distribution"
79           },
80           {
81             "description": "Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats.",
82             "metric": "license_consumption"
83           },
84           {
85             "description": "Detailed team member list including profile, role and invitation metadata.",
86             "metric": "members"
87           },
88           {
89             "description": "Detailed team members captured in the most recent AutoFlex billing cycle.",
90             "metric": "last_autoflex_cycle"
91           },
92           {
93             "description": "Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of  their partner programs and identify engagement opportunities.",
94             "metric": "partner_engagement_funnel"
95           }
96         ],
97         "resource": "team"
98       },
99       {
100         "description": "Reports about Agent Mode usage across workspaces covering user activity, model usage and credit consumption patterns",
101         "metrics": [
102           {
103             "description": "The number of users across your workspaces who run at least one query using Agent Mode over the selected period of time. Use view=summary for a single-record rollup over the duration, or view=trend for a time series.",
104             "metric": "agent_mode_users"
105           },
106           {
107             "description": "Number of messages sent by the user to the agent. Use view=summary for a single-record rollup over the duration, or view=trend for a time series.",
108             "metric": "messages_sent"
109           },
110           {
111             "description": "The number of Agent Mode sessions across your workspaces over the selected period of time. An Agent Mode session starts when a user sends a message using Agent Mode. Use view=summary for a single-record rollup over the duration, or view=trend for a time series.",
112             "metric": "agent_mode_sessions"
113           },
114           {
115             "description": "Breakdown of active users by new and returning users for that time period.",
116             "metric": "new_vs_returning_users"
117           },
118           {
119             "description": "AI credits used by each model over time.",
120             "metric": "credit_usage_by_model"
121           },
122           {
123             "description": "Top Agent Mode models ranked by total credits used. Use view=detailed for a paginated model ranking for that time period.",
124             "metric": "top_agent_models_by_usage"
125           },
126           {
127             "description": "Identifies the peak activity period by credit consumption.",
128             "metric": "peak_activity"
129           },
130           {
131             "description": "Distribution of Agent Mode activity across time buckets.",
132             "metric": "activity_distribution"
133           },
134           {
135             "description": "The number of AI credits used in the current billing cycle across your workspaces. This metric isn't affected by the date range filters.",
136             "metric": "credit_usage"
137           },
138           {
139             "description": "Leaderboard of users ranked by Agent Mode usage by total credits used. Use view=summary for the top 10 users, or view=detailed for a paginated ranking.",
140             "metric": "usage_leaderboard"
141           }
142         ],
143         "resource": "ai"
144       },
145       {
146         "description": "API development activity metrics — workspace counts, entity activity by type (collection, flow, mock, specification, sdk), and top entities.",
147         "metrics": [
148           {
149             "description": "Number of workspaces with API development activity over the selected period, with change percentage.",
150             "metric": "active_workspaces"
151           },
152           {
153             "description": "Active entity count by type (collection, flow, mock, specification, sdk) with change percentage and detailed breakdown.",
154             "metric": "entity_activity"
155           },
156           {
157             "description": "Top entities ranked by action count for a given entity type.",
158             "metric": "top_entities"
159           }
160         ],
161         "resource": "api_development"
162       },
163       {
164         "description": "API testing metrics — total test runs, functional test runs (collection-runner), and performance test runs.",
165         "metrics": [
166           {
167             "description": "Total test run count across all sources with change percentage.",
168             "metric": "runs"
169           },
170           {
171             "description": "Functional test runs via collection-runner (Manual, Scheduled, Postman CLI, CI/CD).",
172             "metric": "functional_test_runs"
173           },
174           {
175             "description": "Performance test run counts with change percentage and top tested collections.",
176             "metric": "performance_test_runs"
177           }
178         ],
179         "resource": "api_testing"
180       },
181       {
182         "description": "API production metrics — monitor run activity and production flow execution activity.",
183         "metrics": [
184           {
185             "description": "Monitor run activity — active monitor count, run volume over time, and top monitors.",
186             "metric": "monitor_runs"
187           },
188           {
189             "description": "Production flow execution activity — active flow count, execution volume over time, and top flows.",
190             "metric": "flow_executions"
191           }
192         ],
193         "resource": "api_production"
194       },
195       {
196         "description": "API distribution metrics — active workspace counts across distribution channels (pvt-network, partner, public).",
197         "metrics": [
198           {
199             "description": "Active workspace count across all distribution channels with trend broken down by channel.",
200             "metric": "active_workspaces"
201           },
202           {
203             "description": "Private API Network workspace activity — count with change percentage and top workspaces.",
204             "metric": "pvt_network"
205           },
206           {
207             "description": "Partner Network workspace activity — count with change percentage and top workspaces.",
208             "metric": "partner"
209           },
210           {
211             "description": "Public API Network workspace activity — count with change percentage and top workspaces.",
212             "metric": "public"
213           }
214         ],
215         "resource": "api_distribution"
216       },
217       {
218         "description": "API management metrics — workspace activity for API management including active counts, trends, and top workspaces.",
219         "metrics": [
220           {
221             "description": "Active workspace count for API management with trend over time and top workspaces.",
222             "metric": "workspace_activity"
223           }
224         ],
225         "resource": "api_management"
226       }
227     ]
228   }
229 }

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

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

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.

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

dataobject

The Analytics API's metadata information.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error