Overview
- The Optimum Parcel Graph API lets you retrieve aggregated metrics and time-series data used for visualization and advanced reporting. You can develop applications that integrate with Optimum Parcel to build custom dashboards, render performance charts, and analyze shipping trends over specific time intervals.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Graph services.
Optimum Parcel App
Optimum Parcel’s graph services give users the visual intelligence needed to understand complex shipping data at a glance and power the interactive charts and trend lines found throughout the analytics dashboard.
Optimum Parcel API
The REST API that allows users to fetch structured datasets, data points, and aggregated metrics formatted to chart libraries from within your app.
Data Visualization
An interface that provides pre-calculated data sets optimized to render bar charts, line graphs, and pie charts, and to reduce the need for heavy client-side processing.
Trend Analysis
A system that aggregates historical shipping performance into time-series data, enabling the identification of spending patterns, volume fluctuations, and carrier performance shifts over time.
What can users do with the Optimum Parcel Graph API?
Users can use the Optimum Parcel Graph API to perform common workflows, such as:
- Retrieve time-series data for shipping spend over the last 12 months
- Fetch aggregated metrics for cost-per-pound or cost-per-package analysis
- Get dataset coordinates for building custom carrier performance comparisons
- Visualize surcharge trends across different service levels
- Access zone distribution data for shipping density heatmaps
- Export raw graph data for internal business intelligence tools
Graph properties available to view, query, and utilize through the Optimum Parcel Graph API:
- Aggregations
- Data Points
- Datasets
- Metrics
- Time Series
