{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/analytics.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/analytics.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/analytics","seo":{"title":"Pitney Analytics Reporting API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Pitney Analytics Reporting API","description":"The Pitney Analytics Reporting APIs provide a unified interface to retrieve operational and financial reporting data across shipping, mailing, refill, and manual transaction activity.\n\nThese APIs are designed for self-serve reporting use cases, including dashboarding, reconciliation, spend analysis, and custom exports based on user-selected filters and dimensions.\n\nIf you are integrating for the first time, follow this path:\n\n1. Authenticate first\n  - Generate an OAuth token using the [Auth API](/openapi/auth/other/getaccesstoken).\n  - Pass `Authorization: Bearer <access_token>` on each request.\n\n2. Discover available reports\n  - Call `GET /api/v1/reports/name` to fetch report names available for the authenticated account.\n\n3. Fetch report metadata\n  - Call `GET /api/v1/reports/metadata` with `reportType` to retrieve supported `measures`, `filters`, and `groupbycolumns`.\n  - Parse these metadata fields before constructing the report request payload.\n\n4. Retrieve report data\n  - Call `POST /api/v1/reports` with date range, pagination, and metadata-driven payload fields.\n  - Use paging parameters to iterate through large datasets.\n\nData returned by the API is controlled by user access and data retention policy. If no custom retention is configured, up to the last 2 years of data is returned.\n\n> For more information, refer to the [Analytics Reference Guide](/docs/analytics/analytics).\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.shipping360.pitneybowes.com","port":4000,"ipAddress":"216.73.217.63"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/analytics","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}