How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Postman analytics API

The analytics API from Postman — 2 operation(s) for analytics.

Postman analytics API is one of 39 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 63 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.

2 operations 2 paths 63 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman analytics API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (scimApiKey).

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

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

analytics 2
GET
/analytics
Get analytics data
getAnalyticsData 15 params → 200400401403500
GET
/analytics-metadata
Get analytics metadata
getAnalyticsMetadata 4 params → 200401403500

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are getAnalyticsMetadataResourceMetricsDataDetailed (6 properties), getAnalyticsDataPartnerEngagmentFunnel (5 properties), getAnalyticsMetadataParametersResponseData (5 properties), commonErrorTypeTitleDetailStatusInstance (5 properties). Each schema is shown below with its type and property counts.

analyticsWorkspaceType
string
GetAnalyticsDataPartnersViewedCollectionSchema
object
1 property
GetAnalyticsDataData
getAnalyticsMetadata
object
1 property
GetAnalyticsDataPartnerRequestSent200OkSchema
object
1 property
getAnalyticsMetadataResourceMetricsDataDetailedData
object
Information about the metric's detailed parameter.
1 property
limitDefault100Max10000
integer
analyticsView
string
getAnalyticsDataPartnerEngagmentFunnel
object
5 properties
getAnalyticsDataPartnersViewedCollection
object
Information about partner users' views of collections in a workspace.
3 properties
CommonErrorTypeTitleDetailStatusType
analyticsResponseStatus
string
CommonErrorNameMessageError
object
Information about the error.
2 properties
getAnalyticsDataPartnerRequestSent
object
Information about requests sent by partner users.
3 properties
offsetMax10000
integer
getAnalyticsDataPartnerRequestSent200OK
object
Information about partner users' successful request calls in a workspace.
3 properties
analyticsRequestId
string
commonErrorTypeTitleDetail
object
3 properties
getAnalyticsMetadataResourceMetricsDataDetailedParameters
object
Information about the metric's parameters.
3 properties
GetAnalyticsDataRowsDataItemsItems
getAnalyticsDataAllPartners
object
Information about partner users and their activity.
3 properties
GetAnalyticsDataRequestInternalServerError
getAnalyticsDataSchema
object
1 property
getAnalyticsData
object
1 property 1 required
analyticsMetadataResources
string
GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema
object
The response schema for the summary view.
1 property
getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData
object
Information about the filter.
3 properties
GetAnalyticsMetadataData
object
The Analytics API's metadata information.
2 properties
getAnalyticsMetadataResourceMetricsDataDetailed
object
Information about the resource's metric.
6 properties
analyticsMetrics
string
getAnalyticsMetadataResourceMetricsDataSummaryData
object
Information about the metric's summary parameter.
1 property
analyticsUserId
string
getAnalyticsDataColumnsData
array
A list of column entries.
getAnalyticsMetadataResourceMetricsDataDetailedResponse
object
Information about the metric's response parameters.
2 properties
getAnalyticsDataPartnerWorkspaceVisited
object
Information about partner users' workspace visits.
3 properties
getAnalyticsMetadataResourceData
object
Information about the resource.
3 properties
GetAnalyticsDataColumnsDataItemsType
string
The data type of the column.
getAnalyticsMetadataParametersResponseData
object
Detailed information about the resource including its metrics, parameters, and response schema.
5 properties
commonErrorTypeTitleDetailStatus
object
4 properties
GetAnalyticsDataColumnsDataItems
object
4 properties
analyticsMetadataInclude
string
GetAnalyticsMetadataRequestInternalServerError
getAnalyticsDataRowsData
array
A list of data row entries. Each row is an array of values that correspond to the columns defined in the schema.
GetAnalyticsDataPartnerRequestSentSchema
object
1 property
getAnalyticsDataSummary
object
1 property 1 required
getAnalyticsDataObject
object
Data analytics information.
3 properties
commonErrorTypeTitleDetailStatusInstance
object
5 properties
GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema
object
The response schema for the detailed view.
1 property
getAnalticsMetadataPaginationData
object
Information about the metric's pagination parameters.
2 properties
GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1
object
Information about the filter parameters.
2 properties
getAnalyticsMetadataResourceMetricsData
object
Information about the resource's metric.
2 properties
analyticsEntityType
string
commonErrorNameMessage
object
1 property
GetAnalyticsMetadataDataResourcesItems
getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters
analyticsDuration
string
analyticsUserType
string
CommonErrorTypeTitleDetailDetail
Information about the error.
analyticsPeriod
string
getAnalyticsDataPaginationData
object
Information about the response pagination.
4 properties
analyticsResource
string
getAnalyticsMetadataResourceMetricsDataDetailedParametersView
object
Information about the view parameter.
4 properties
analyticsAttentionType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-analytics-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman Collections API
Postman Workspaces API
Postman Environments API
Postman Monitors API
Postman Webhooks API
Postman Tags API
Postman Billing API
Postman SCIM API
Postman MCP Server
Postman Flows
Postman Mocks API
Where this information came from

This is an independent, third-party profile of Postman analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.