The EPISHIP Widgets API allows you to programmatically retrieve data for dashboard visualizations. You can develop applications that display real-time metrics such as shipment counts, billing velocity graphs, payout summaries, and top shipment locations, providing users with instant insights into their logistics performance.
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Widget services.
Figure 1. EPISHIP API relationship diagram. Dashboard metric retrieval and visualization flow.
EPISHIP’s dashboard is built upon a modular widget system. Users see an immediate snapshot of their business health, including graphs for daily shipment volumes, alerts for unpaid invoices, and geographical breakdowns of their shipping destinations.
The REST API that powers these visual components. It aggregates complex data from various backend services (shipping, billing, user management) and delivers it in a simplified JSON format, ready to be rendered by charting libraries or custom UI elements.
Secured via Bearer tokens in the Authorization header. API access is scoped to the authenticated user’s company, ensuring that the financial and operational metrics returned are strictly relevant to their specific organization.
The API supports a variety of pre-defined widgets, including `shipment_count`, `billing_velocity_graph`, `payout_credit`, `top_shipment_locations`, and `unpaid_invoices`. Each widget endpoint returns data structured specifically for its intended visualization type (e.g., time-series data for graphs, scalar values for counters).
Users can use the EPISHIP Widgets API to perform common workflows, such as:
Widget properties available to view and filter through the EPISHIP Widgets API:
