> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. For full content including API reference and SDK examples, see https://learning.postman.com/llms-full.txt. # Get analytics metadata GET https://api.getpostman.com/analytics-metadata 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. Reference: https://learning.postman.com/api-docs/api-reference/analytics/get-analytics-metadata ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Postman API version: 1.0.0 paths: /analytics-metadata: get: operationId: getAnalyticsMetadata summary: Get analytics metadata description: >- 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. tags: - analytics parameters: - name: include in: query description: > 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. required: false schema: $ref: '#/components/schemas/analyticsMetadataInclude' - name: resources in: query description: >- A comma-separated list of resource types to filter the metrics by. Accepts the `user`, `workspace`, `team`, and `ai` values. required: false schema: $ref: '#/components/schemas/analyticsMetadataResources' - name: metrics in: query description: > 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. required: false schema: $ref: '#/components/schemas/analyticsMetrics' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAnalyticsMetadata' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '500': description: Internal Server Error content: application/json: schema: $ref: >- #/components/schemas/GetAnalyticsMetadataRequestInternalServerError servers: - url: https://api.getpostman.com description: https://api.getpostman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com components: schemas: analyticsMetadataInclude: type: string title: analyticsMetadataInclude analyticsMetadataResources: type: string title: analyticsMetadataResources analyticsMetrics: type: string enum: - active_users - workspace_active_users - elements_in_workspace - active_workspaces - api_calls - active_collections - response_status - pending_invites - needs_attention - success_rate - user_requests - user_api_journey - workspace_distribution - internal_workspace_distribution - license_consumption - members - last_autoflex_cycle - partner_engagement_funnel - collection_error_aggregate - agent_mode_users - new_vs_returning_users - agent_mode_sessions - messages_sent - credit_usage - credit_usage_by_model - usage_leaderboard - peak_activity - activity_distribution - top_agent_models_by_usage - entity_activity - top_entities - runs - functional_test_runs - performance_test_runs - monitor_runs - flow_executions - pvt_network - partner - public - workspace_activity title: analyticsMetrics getAnalyticsMetadataResourceMetricsData: type: object properties: metric: type: string description: The metric's name. description: type: string description: A description of the metric. description: Information about the resource's metric. title: getAnalyticsMetadataResourceMetricsData getAnalyticsMetadataResourceData: type: object properties: resource: type: string description: The name of the resource. description: type: string description: A description of the resource. metrics: type: array items: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsData' description: A list of the resource's accepted metrics values. description: Information about the resource. title: getAnalyticsMetadataResourceData getAnalyticsMetadataResourceMetricsDataDetailedParametersView: type: object properties: type: type: string description: The parameter's type. isRequired: type: boolean description: If true, the parameter is required. allowed_values: type: array items: type: string description: A list of the parameter's accepted values. description: type: string description: The parameter's description. description: Information about the `view` parameter. title: getAnalyticsMetadataResourceMetricsDataDetailedParametersView getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData: type: object properties: type: type: string description: The parameter's type. isRequired: type: boolean description: If true, the parameter is required. allowed_values: type: array items: type: string description: A list of the parameter's accepted values. description: Information about the filter. title: getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1: type: object properties: workspace_type: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData duration: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData description: Information about the filter parameters. title: GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1 getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters: oneOf: - type: array items: type: string - $ref: >- #/components/schemas/GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1 title: getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters getAnalticsMetadataPaginationData: type: object properties: supported: type: boolean description: If true, pagination is supported for this metric. allowed_values: type: array items: type: string description: A list of the supported pagination parameters. description: Information about the metric's pagination parameters. title: getAnalticsMetadataPaginationData getAnalyticsMetadataResourceMetricsDataDetailedParameters: type: object properties: view: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersView filters: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters pagination: $ref: '#/components/schemas/getAnalticsMetadataPaginationData' description: Information about the metric's parameters. title: getAnalyticsMetadataResourceMetricsDataDetailedParameters GetAnalyticsDataColumnsDataItemsType: type: string enum: - DATE - STRING - INTEGER - TIMESTAMP - BOOLEAN - NUMBER - FLOAT description: The data type of the column. title: GetAnalyticsDataColumnsDataItemsType GetAnalyticsDataColumnsDataItems: type: object properties: name: type: string description: The name of the column. type: $ref: '#/components/schemas/GetAnalyticsDataColumnsDataItemsType' description: The data type of the column. format: type: string description: The data type's format. description: type: string description: A description of what the column represents. title: GetAnalyticsDataColumnsDataItems getAnalyticsDataColumnsData: type: array items: $ref: '#/components/schemas/GetAnalyticsDataColumnsDataItems' description: A list of column entries. title: getAnalyticsDataColumnsData GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema: type: object properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' description: The response schema for the `detailed` view. title: GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema getAnalyticsMetadataResourceMetricsDataDetailedData: type: object properties: schema: $ref: >- #/components/schemas/GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema description: The response schema for the `detailed` view. description: Information about the metric's `detailed` parameter. title: getAnalyticsMetadataResourceMetricsDataDetailedData GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema: type: object properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' description: The response schema for the `summary` view. title: GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema getAnalyticsMetadataResourceMetricsDataSummaryData: type: object properties: schema: $ref: >- #/components/schemas/GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema description: The response schema for the `summary` view. description: Information about the metric's `summary` parameter. title: getAnalyticsMetadataResourceMetricsDataSummaryData getAnalyticsMetadataResourceMetricsDataDetailedResponse: type: object properties: detailed: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedData summary: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataSummaryData description: Information about the metric's `response` parameters. title: getAnalyticsMetadataResourceMetricsDataDetailedResponse getAnalyticsMetadataResourceMetricsDataDetailed: type: object properties: metric: type: string description: The metric's name. description: type: string description: A description of the metric. type: type: string description: The metric's data type. isRequired: type: boolean description: If true, the metric is required. parameters: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParameters response: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedResponse description: Information about the resource's metric. title: getAnalyticsMetadataResourceMetricsDataDetailed getAnalyticsMetadataParametersResponseData: type: object properties: resource: type: string description: The name of the resource. description: type: string description: A description of the resource. type: type: string description: The metric's data type. isRequired: type: boolean description: If true, the metric is required. metrics: type: array items: $ref: >- #/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailed description: A list of the resource's detailed accepted metrics values. description: >- Detailed information about the resource including its metrics, parameters, and response schema. title: getAnalyticsMetadataParametersResponseData GetAnalyticsMetadataDataResourcesItems: oneOf: - $ref: '#/components/schemas/getAnalyticsMetadataResourceData' - $ref: '#/components/schemas/getAnalyticsMetadataParametersResponseData' title: GetAnalyticsMetadataDataResourcesItems GetAnalyticsMetadataData: type: object properties: description: type: string description: A description of the endpoint. resources: type: array items: $ref: '#/components/schemas/GetAnalyticsMetadataDataResourcesItems' description: A list of accepted resource values. description: The Analytics API's metadata information. title: GetAnalyticsMetadataData getAnalyticsMetadata: type: object properties: data: $ref: '#/components/schemas/GetAnalyticsMetadataData' description: The Analytics API's metadata information. title: getAnalyticsMetadata commonErrorTypeTitleDetailStatusInstance: type: object properties: type: type: string format: uri-reference description: >- The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. title: type: string description: A short summary of the problem. detail: type: string description: An explanation about the problem. status: type: integer description: The HTTP status code generated by the origin server. instance: type: string description: >- The URI reference that identifies the specific occurrence of the problem. title: commonErrorTypeTitleDetailStatusInstance CommonErrorTypeTitleDetailDetail: oneOf: - type: string - type: object additionalProperties: description: Any type description: Information about the error. title: CommonErrorTypeTitleDetailDetail commonErrorTypeTitleDetail: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. detail: $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail' description: Information about the error. title: commonErrorTypeTitleDetail CommonErrorTypeTitleDetailStatusType: oneOf: - type: string format: uri-reference - type: string title: CommonErrorTypeTitleDetailStatusType commonErrorTypeTitleDetailStatus: type: object properties: type: $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType' title: type: string description: A short summary of the problem. detail: type: string description: Information about the error. status: type: integer description: The error's HTTP status code. title: commonErrorTypeTitleDetailStatus CommonErrorNameMessageError: type: object properties: name: type: string description: The error name. message: type: string description: The error message. description: Information about the error. title: CommonErrorNameMessageError commonErrorNameMessage: type: object properties: error: $ref: '#/components/schemas/CommonErrorNameMessageError' description: Information about the error. title: commonErrorNameMessage GetAnalyticsMetadataRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetAnalyticsMetadataRequestInternalServerError securitySchemes: PostmanApiKey: type: apiKey in: header name: x-api-key scimApiKey: type: apiKey in: header name: Authorization description: >- 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. basicAuth: type: http scheme: basic ``` ## Examples ### Successful Response **Response** ```json { "data": { "description": "Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman", "resources": [ { "description": "User-level metrics and insights describing activities and engagement within Postman workspaces.", "metrics": [ { "description": "Users who used postman at least once.", "metric": "active_users" }, { "description": "Users who created, edited or sent requests within an individual workspace.", "metric": "workspace_active_users" } ], "resource": "user" }, { "description": "Workspace-level metrics and insights about activities and collaboration patterns", "metrics": [ { "description": "Total count of workspace elements (collections, environments, mocks and monitors) over time.", "metric": "elements_in_workspace" }, { "description": "List of active workspaces in the selected period based on edits and API requests sent.", "metric": "active_workspaces" }, { "description": "Aggregated API call counts across workspaces.", "metric": "api_calls" }, { "description": "List of collections that have been edited or used to send API requests.", "metric": "active_collections" }, { "description": "Breakdown of API response codes (2xx, 4xx, 5xx) over time.", "metric": "response_status" }, { "description": "List of pending workspace invitations including target email addresses and invite timestamps.", "metric": "pending_invites" }, { "description": "Identifies partners or users needing attention (e.g., no successful requests or high error rates) for proactive support.", "metric": "needs_attention" }, { "description": "Percentage of successful responses (2xx) over time", "metric": "success_rate" }, { "description": "Request-level data for individual users including request names, collections, response statuses and timestamps.", "metric": "user_requests" }, { "description": "Aggregated error metrics (4xx, 5xx responses) per collection, helping identify collections with the highest error rates.", "metric": "collection_error_aggregate" } ], "resource": "workspace" }, { "description": "Team-level metrics and insights on team activity, license consumption, and organizational workspace trends", "metrics": [ { "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.", "metric": "user_api_journey" }, { "description": "Distribution of workspace types (team, private, partner, public) over time.", "metric": "workspace_distribution" }, { "description": "Distribution of internal workspaces created into team-shared and private categories.", "metric": "internal_workspace_distribution" }, { "description": "Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats.", "metric": "license_consumption" }, { "description": "Detailed team member list including profile, role and invitation metadata.", "metric": "members" }, { "description": "Detailed team members captured in the most recent AutoFlex billing cycle.", "metric": "last_autoflex_cycle" }, { "description": "Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of their partner programs and identify engagement opportunities.", "metric": "partner_engagement_funnel" } ], "resource": "team" }, { "description": "Reports about Agent Mode usage across workspaces covering user activity, model usage and credit consumption patterns", "metrics": [ { "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.", "metric": "agent_mode_users" }, { "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.", "metric": "messages_sent" }, { "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.", "metric": "agent_mode_sessions" }, { "description": "Breakdown of active users by new and returning users for that time period.", "metric": "new_vs_returning_users" }, { "description": "AI credits used by each model over time.", "metric": "credit_usage_by_model" }, { "description": "Top Agent Mode models ranked by total credits used. Use view=detailed for a paginated model ranking for that time period.", "metric": "top_agent_models_by_usage" }, { "description": "Identifies the peak activity period by credit consumption.", "metric": "peak_activity" }, { "description": "Distribution of Agent Mode activity across time buckets.", "metric": "activity_distribution" }, { "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.", "metric": "credit_usage" }, { "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.", "metric": "usage_leaderboard" } ], "resource": "ai" }, { "description": "API development activity metrics — workspace counts, entity activity by type (collection, flow, mock, specification, sdk), and top entities.", "metrics": [ { "description": "Number of workspaces with API development activity over the selected period, with change percentage.", "metric": "active_workspaces" }, { "description": "Active entity count by type (collection, flow, mock, specification, sdk) with change percentage and detailed breakdown.", "metric": "entity_activity" }, { "description": "Top entities ranked by action count for a given entity type.", "metric": "top_entities" } ], "resource": "api_development" }, { "description": "API testing metrics — total test runs, functional test runs (collection-runner), and performance test runs.", "metrics": [ { "description": "Total test run count across all sources with change percentage.", "metric": "runs" }, { "description": "Functional test runs via collection-runner (Manual, Scheduled, Postman CLI, CI/CD).", "metric": "functional_test_runs" }, { "description": "Performance test run counts with change percentage and top tested collections.", "metric": "performance_test_runs" } ], "resource": "api_testing" }, { "description": "API production metrics — monitor run activity and production flow execution activity.", "metrics": [ { "description": "Monitor run activity — active monitor count, run volume over time, and top monitors.", "metric": "monitor_runs" }, { "description": "Production flow execution activity — active flow count, execution volume over time, and top flows.", "metric": "flow_executions" } ], "resource": "api_production" }, { "description": "API distribution metrics — active workspace counts across distribution channels (pvt-network, partner, public).", "metrics": [ { "description": "Active workspace count across all distribution channels with trend broken down by channel.", "metric": "active_workspaces" }, { "description": "Private API Network workspace activity — count with change percentage and top workspaces.", "metric": "pvt_network" }, { "description": "Partner Network workspace activity — count with change percentage and top workspaces.", "metric": "partner" }, { "description": "Public API Network workspace activity — count with change percentage and top workspaces.", "metric": "public" } ], "resource": "api_distribution" }, { "description": "API management metrics — workspace activity for API management including active counts, trends, and top workspaces.", "metrics": [ { "description": "Active workspace count for API management with trend over time and top workspaces.", "metric": "workspace_activity" } ], "resource": "api_management" } ] } } ``` **SDK Code** ```python Successful Response import requests url = "https://api.getpostman.com/analytics-metadata" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Successful Response const url = 'https://api.getpostman.com/analytics-metadata'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Successful Response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/analytics-metadata" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Successful Response require 'uri' require 'net/http' url = URI("https://api.getpostman.com/analytics-metadata") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Successful Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/analytics-metadata") .header("x-api-key", "") .asString(); ``` ```php Successful Response request('GET', 'https://api.getpostman.com/analytics-metadata', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Successful Response using RestSharp; var client = new RestClient("https://api.getpostman.com/analytics-metadata"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Successful Response import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/analytics-metadata")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Fitler Results by Resource with Parameters and Response Data **Response** ```json { "data": { "description": "Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman", "resources": [ { "description": "User-level metrics and insights describing activities and engagement within Postman workspaces.", "isRequired": true, "metrics": [ { "description": "Users who used postman at least once.", "isRequired": true, "metric": "active_users", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed", "summary" ], "description": "Determines whether the metric returns detailed or summarized data.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Reporting date for the metric", "format": "YYYY-MM-DD", "name": "timestamp", "type": "DATE" }, { "description": "Unique identifier assigned to the user.", "name": "user_id", "type": "STRING" }, { "description": "Date when the user joined the team.", "name": "team_joining_date", "type": "DATE" }, { "description": "Timestamp of the user's most recent activity.", "format": "YYYY-MM-DDTHH:MM:SSZ", "name": "last_active_ts", "type": "TIMESTAMP" }, { "description": "Total number of API requests made by the user.", "name": "api_requests_count", "type": "INTEGER" } ] } }, "summary": { "schema": { "columns": [ { "description": "Total number of active users in the selected period.", "name": "count", "type": "INTEGER" }, { "description": "Percentage change from the previous period.", "name": "change", "type": "FLOAT" }, { "description": "Indicates whether the metric increased or decreased.", "name": "change_type", "type": "STRING" } ] } } }, "type": "string" }, { "description": "Users who created, edited or sent requests within an individual workspace.", "isRequired": true, "metric": "workspace_active_users", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether the metric returns detailed or summarized data.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Summarized total count.", "name": "count", "type": "INTEGER" } ] } } }, "type": "string" } ], "resource": "user", "type": "string" }, { "description": "Workspace-level metrics and insights about activities and collaboration patterns", "isRequired": true, "metrics": [ { "description": "Total count of workspace elements (collections, environments, mocks and monitors) over time.", "isRequired": true, "metric": "elements_in_workspace", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month", "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for the metric.", "format": "YYYY-MM-DD", "name": "timestamp", "type": "DATE" }, { "description": "Number of collections in the selected period.", "name": "collections_count", "type": "INTEGER" }, { "description": "Number of environments in the selected period.", "name": "environments_count", "type": "INTEGER" }, { "description": "Number of mocks in the selected period.", "name": "mocks_count", "type": "INTEGER" }, { "description": "Number of monitors in the selected period.", "name": "monitors_count", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "List of active workspaces in the selected period based on edits and API requests sent.", "isRequired": true, "metric": "active_workspaces", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed", "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Indicates whether the workspace is hidden from the user.", "name": "is_hidden", "type": "BOOLEAN" }, { "description": "Display name of the workspace.", "name": "workspace_name", "type": "STRING" }, { "description": "Unique identifier for the workspace.", "name": "workspace_id", "type": "STRING" }, { "description": "Name of the user who created the workspace", "name": "created_by", "type": "STRING" }, { "description": "Visibility type of the workspace such as Internal, Partner or Public", "name": "type", "type": "STRING" }, { "description": "Number of contributors to the workspace.", "name": "contributors", "type": "INTEGER" }, { "description": "Number of API requests sent in the workspace.", "name": "api_calls", "type": "INTEGER" } ] } }, "summary": { "schema": { "columns": [ { "description": "Summarized total count.", "name": "count", "type": "INTEGER" }, { "description": "Percentage or numeric change from the previous period.", "name": "change", "type": "FLOAT" }, { "description": "Indicates whether the change is an increase or decrease.", "name": "change_type", "type": "STRING" } ] } } }, "type": "string" }, { "description": "Aggregated API call counts across workspaces.", "isRequired": true, "metric": "api_calls", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Summarized total count.", "name": "count", "type": "INTEGER" }, { "description": "Percentage or numeric change from the previous period.", "name": "change", "type": "FLOAT" }, { "description": "Indicates whether the change is an increase or decrease.", "name": "change_type", "type": "STRING" } ] } } }, "type": "string" }, { "description": "List of collections that have been edited or used to send API requests.", "isRequired": true, "metric": "active_collections", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Indicates whether the collection is hidden from the user.", "name": "is_hidden", "type": "BOOLEAN" }, { "description": "Unique identifier for the collection.", "name": "collection_id", "type": "STRING" }, { "description": "Display name of the collection.", "name": "collection_name", "type": "STRING" }, { "description": "Name of the workspace containing the collection.", "name": "workspace_name", "type": "STRING" }, { "description": "Name of the user who created the collection.", "name": "created_by", "type": "STRING" }, { "description": "Total number of API calls made using requests in this collection.", "name": "api_calls_count", "type": "INTEGER" }, { "description": "Last updated timestamp for the collection.", "format": "YYYY-MM-DDTHH:MM:SSZ", "name": "last_edited_on", "type": "TIMESTAMP" } ] } } }, "type": "string" }, { "description": "Breakdown of API response codes (2xx, 4xx, 5xx) over time.", "isRequired": true, "metric": "response_status", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month", "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for the metric.", "format": "YYYY-MM-DD", "name": "timestamp", "type": "DATE" }, { "description": "Total number of API requests for the selected period.", "name": "total_count", "type": "INTEGER" }, { "description": "Number of successful API responses (2xx).", "name": "count_2xx", "type": "INTEGER" }, { "description": "Number of redirection responses (3xx).", "name": "count_3xx", "type": "INTEGER" }, { "description": "Number of client error responses (4xx).", "name": "count_4xx", "type": "INTEGER" }, { "description": "Number of server error responses (5xx).", "name": "count_5xx", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "List of pending workspace invitations including target email addresses and invite timestamps.", "isRequired": true, "metric": "pending_invites", "parameters": { "filters": [], "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary", "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Invitee's target email.", "name": "email_id", "type": "STRING" }, { "description": "Unique identifier for the invite.", "name": "invite_id", "type": "STRING" }, { "description": "Timestamp when the invite was created.", "format": "YYYY-MM-DDTHH:MM:SSZ", "name": "timestamp", "type": "TIMESTAMP" } ] } }, "summary": { "schema": { "columns": [ { "description": "Number of pending invites.", "name": "count", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Identifies partners or users needing attention (e.g., no successful requests or high error rates) for proactive support.", "isRequired": true, "metric": "needs_attention", "parameters": { "filters": { "duration": { "allowed_values": [ "last_30_days" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary", "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Number of partners who need attention.", "name": "count", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Percentage of successful responses (2xx) over time", "isRequired": true, "metric": "success_rate", "parameters": { "filters": { "duration": { "allowed_values": [ "last_30_days" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary", "detailed" ], "description": "Determines whether detailed or summarized data is returned.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Human-readable name of the request.", "name": "request_name", "type": "STRING" }, { "description": "Unique identifier for the specific request definition.", "name": "request_identifier_id", "type": "STRING" }, { "description": "Name of the collection containing the request.", "name": "collection_name", "type": "STRING" }, { "description": "Number of successful responses received.", "name": "success_count", "type": "INTEGER" }, { "description": "Number of API requests sent.", "name": "total_requests", "type": "INTEGER" } ] } }, "summary": { "schema": { "columns": [ { "description": "Overall percentage of successful requests.", "name": "success_rate", "type": "FLOAT" }, { "description": "Change in success rate compared to the previous period.", "name": "change", "type": "FLOAT" }, { "description": "Indicates whether the success rate increased or decreased.", "name": "change_type", "type": "STRING" } ] } } }, "type": "string" }, { "description": "Request-level data for individual users including request names, collections, response statuses and timestamps.", "isRequired": true, "metric": "user_requests", "parameters": { "filters": { "duration": { "allowed_values": [ "last_180_days" ], "isRequired": true, "type": "ENUM" }, "request_id": { "description": "Filter by the request's unique identifier.", "isRequired": false, "type": "STRING" }, "response_status": { "description": "Filter by the response status code.", "isRequired": false, "type": "STRING" }, "user_id": { "description": "Filter by the user's unique identifier", "isRequired": false, "type": "STRING" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Unique identifier of the user who sent the request.", "name": "user_id", "type": "STRING" }, { "description": "Human-readable name of the request made by the user.", "name": "request_name", "type": "STRING" }, { "description": "Unique identifier of the specific request sent.", "name": "request_identifier_id", "type": "STRING" }, { "description": "Name of the collection containing the request.", "name": "collection_name", "type": "STRING" }, { "description": "Unique Identifier of the collection containing the request.", "name": "collection_id", "type": "STRING" }, { "description": "Unique Identifier of the workspace containing the collection.", "name": "workspace_id", "type": "STRING" }, { "description": "HTTP response code returned for the request.", "name": "response_status", "type": "INTEGER" }, { "description": "Timestamp when the request was made.", "format": "YYYY-MM-DDTHH:MM:SSZ", "name": "request_ts", "type": "TIMESTAMP" } ] } } }, "type": "string" }, { "description": "Aggregated error metrics (4xx, 5xx responses) per collection, helping identify collections with the highest error rates.", "isRequired": true, "metric": "collection_error_aggregate", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month", "last_6_months" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "Indicates whether the collection is hidden from the user.", "name": "is_hidden", "type": "BOOLEAN" }, { "description": "Unique identifier for the collection.", "name": "collection_id", "type": "STRING" }, { "description": "Name of the collection.", "name": "collection_name", "type": "STRING" }, { "description": "Unique identifier of the workspace containing the collection.", "name": "workspace_id", "type": "STRING" }, { "description": "Number of 4xx responses for the collection in the selected period.", "name": "count_4xx", "type": "INTEGER" }, { "description": "Number of 5xx responses for the collection in the selected period.", "name": "count_5xx", "type": "INTEGER" }, { "description": "Number of API calls for the collection in the selected period.", "name": "total_api_calls", "type": "INTEGER" } ] } } }, "type": "string" } ], "resource": "workspace", "type": "string" }, { "description": "Team-level metrics and insights on team activity, license consumption, and organizational workspace trends", "isRequired": true, "metrics": [ { "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.", "isRequired": true, "metric": "user_api_journey", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month", "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for aggregated user activity metrics.", "format": "YYYY-MM-DD", "name": "timestamp", "type": "DATE" }, { "description": "Number of users active in the selected date.", "name": "active_user", "type": "INTEGER" }, { "description": "Number of users who made at least one API call.", "name": "api_user", "type": "INTEGER" }, { "description": "Number of users making API calls for the first time.", "name": "new_api_user", "type": "INTEGER" }, { "description": "Number of users whose API calls were mostly successful.", "name": "successful", "type": "INTEGER" }, { "description": "Number of users who encountered only error responses.", "name": "error_only", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Distribution of workspace types (team, private, partner, public) over time.", "isRequired": true, "metric": "workspace_distribution", "parameters": { "filters": { "duration": { "allowed_values": [ "last_month", "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for the aggregated workspace counts.", "format": "YYYY-MM-DD", "name": "date", "type": "DATE" }, { "description": "Number of workspaces for the given date.", "name": "total", "type": "INTEGER" }, { "description": "Number of internal workspaces.", "name": "internal", "type": "INTEGER" }, { "description": "Number of partner workspaces.", "name": "partner", "type": "INTEGER" }, { "description": "Number of public workspaces.", "name": "public", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Distribution of internal workspaces created into team-shared and private categories.", "isRequired": true, "metric": "internal_workspace_distribution", "parameters": { "filters": { "duration": { "allowed_values": [ "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for internal workspace distribution.", "format": "YYYY-MM-DD", "name": "date", "type": "DATE" }, { "description": "Count of internal team-shared workspaces.", "name": "internal_team_shared", "type": "INTEGER" }, { "description": "Count of internal private workspaces.", "name": "internal_private", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats.", "isRequired": true, "metric": "license_consumption", "parameters": { "filters": { "duration": { "allowed_values": [ "last_6_months" ], "isRequired": true, "type": "ENUM" }, "workspace_type": { "allowed_values": [ "internal", "public", "partner" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "summary": { "schema": { "columns": [ { "description": "Reporting date for team and license metrics.", "format": "YYYY-MM-DD", "name": "date", "type": "DATE" }, { "description": "Total number of team members.", "name": "team_members", "type": "INTEGER" }, { "description": "Number of team members actively using Postman.", "name": "active_postman_users", "type": "INTEGER" }, { "description": "Number of partner users invited to the team.", "name": "partners", "type": "INTEGER" }, { "description": "Number of guest users in the team.", "name": "guests", "type": "INTEGER" }, { "description": "Number of unused team member licenses.", "name": "unused_licenses", "type": "INTEGER" } ] } } }, "type": "string" }, { "description": "Detailed team member list including profile, role and invitation metadata.", "isRequired": true, "metric": "members", "parameters": { "filters": [], "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "User's name.", "name": "user_name", "type": "STRING" }, { "description": "Email ID of user.", "name": "email", "type": "STRING" }, { "description": "Timestamp when user was added to team.", "name": "added_in_team", "type": "DATE" }, { "description": "Timestamp when user was last active.", "name": "last_active", "type": "DATE" }, { "description": "Concatenated list of roles that user has.", "name": "user_role", "type": "STRING" }, { "description": "Email ID that invited this user.", "name": "invited_by", "type": "STRING" }, { "description": "Type of invitation.", "name": "invite_type", "type": "STRING" }, { "description": "Describes whether the user's public profile is enabled or not.", "name": "public_profile_enabled", "type": "STRING" } ] } } }, "type": "string" }, { "description": "Detailed team members captured in the most recent AutoFlex billing cycle.", "isRequired": true, "metric": "last_autoflex_cycle", "parameters": { "filters": [], "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "schema": { "columns": [ { "description": "User's name.", "name": "name", "type": "STRING" }, { "description": "Email ID of user.", "name": "email", "type": "STRING" }, { "description": "Timestamp when user was last active.", "name": "last_active", "type": "DATE" }, { "description": "Email ID that invited this user.", "name": "invited_by", "type": "STRING" }, { "description": "Timestamp when user joined team.", "name": "joined_date", "type": "DATE" }, { "description": "Concatenated list of roles that user has.", "name": "user_role", "type": "STRING" } ] } } }, "type": "string" }, { "description": "Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of their partner programs and identify engagement opportunities.", "isRequired": true, "metric": "partner_engagement_funnel", "parameters": { "filters": { "duration": { "allowed_values": [ "last_180_days" ], "isRequired": true, "type": "ENUM" } }, "pagination": { "allowed_values": [ "offset", "limit" ], "supported": true }, "view": { "allowed_values": [ "summary", "detailed" ], "description": "Determines whether detailed or summarized data is returned for this metric.", "isRequired": false, "type": "ENUM" } }, "response": { "detailed": { "description": "Returns data grouped by funnel stages: all_partners, workspace_visited, viewed_collection, request_sent, successful_requests_200OK. Each stage contains a list of partners who reached that stage.", "funnel_stages": [ "all_partners", "workspace_visited", "viewed_collection", "request_sent", "successful_requests_200OK" ], "schema": { "columns": [ { "description": "Unique identifier of the partner user.", "name": "user_id", "type": "STRING" }, { "description": "Timestamp when the partner activity was recorded.", "format": "YYYY-MM-DDTHH:MM:SSZ", "name": "timestamp", "type": "TIMESTAMP" } ] } }, "summary": { "schema": { "columns": [ { "description": "Name of the partner engagement metric.", "name": "metric", "type": "STRING" }, { "description": "Value associated with the specific engagement metric.", "name": "count", "type": "INTEGER" } ] } } }, "type": "string" } ], "resource": "team", "type": "string" } ] } } ``` **SDK Code** ```python Fitler Results by Resource with Parameters and Response Data import requests url = "https://api.getpostman.com/analytics-metadata" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Fitler Results by Resource with Parameters and Response Data const url = 'https://api.getpostman.com/analytics-metadata'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Fitler Results by Resource with Parameters and Response Data package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/analytics-metadata" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Fitler Results by Resource with Parameters and Response Data require 'uri' require 'net/http' url = URI("https://api.getpostman.com/analytics-metadata") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Fitler Results by Resource with Parameters and Response Data import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/analytics-metadata") .header("x-api-key", "") .asString(); ``` ```php Fitler Results by Resource with Parameters and Response Data request('GET', 'https://api.getpostman.com/analytics-metadata', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Fitler Results by Resource with Parameters and Response Data using RestSharp; var client = new RestClient("https://api.getpostman.com/analytics-metadata"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Fitler Results by Resource with Parameters and Response Data import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/analytics-metadata")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```