EPISHIP API Widgets overview

EPISHIP Widgets API icon 32px svg

Overview

Figure 1. EPISHIP API relationship diagram. Dashboard metric retrieval and visualization flow.

EPISHIP App

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.

EPISHIP API

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.

Authentication

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.

Available Widgets

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).

What can users do with the EPISHIP Widgets API?

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:

Additional info

Related

Related Categories