1. ShipEngine
  2. ShipEngine Help Center
  3. Getting Started

Analytics Pages

Avatar

ShipEngine Content Team

Updated

ShipStation API Analytics is now available in your ShipStation API Portal and gives you the data you need to optimize cost, performance, and customer experience across carriers—without building custom tools or stitching together reports.

The sections below provide details about the available dashboards. If you are new to ShipStation API, you may not have enough data to populate some of the charts and tables provided in these pages. More data will become available over time as you import and ship your orders.

Carrier Performance Dashboard

This dashboard provides a geographical heat map to visualize carrier performance (on-time, early, or delayed deliveries) across the United States to help you identify problematic shipping areas as well as the general performance of your carriers.

API_Analytics_Carrier_Performance.png

Labels Overview Dashboard

This Dashboard provides a retrospective look at label usage and costs. You can filter this dashboard by Warehouse name, return labels, international labels, or label creation date.

API_Analytics_Label_Overview.png

Tracking Events Dashboard

This dashboard provides a real-time view of all shipping tracking events, focusing on the status of packages and any exceptions to help with you proactively manage your customer's delivery expectations.

API_Analytics_Tracking_Events.png

API Overview Dashboard

These pages provide data visualizations to give you at-a-glance information about your:

  • Last API Call Date

  • API Calls in the last 30 days

  • Percentage of Successful Requests

  • Overall and per call latency in milliseconds

  • Daily API Call and Error Rates

  • Coming Soon: Spend by Carrier, Operations Overview, and Potential Savings dashboards

API_Analytics_Overview.png

Download or Schedule Raw Data Reports

Raw data reports are available for each dashboard as well as per widget in the dashboard. To download or schedule your raw data export please follow the steps below:

  1. Click the vertical ellipsis kebab_menu.png next to the information you wish to download.

  2. Select the option to Download a CSV or Schedule a Delivery.

    If you choose the option to Download a CSV it will begin immediately, if you choose to Schedule Delivery proceed to the next step.

  3. Set the filters your report will need in the pop up menu.

    API_Analytics_Data_Scheduled_Delivery_Filters.png

  4. Set any desired Advanced Options.

    API_Analytics_Data_Scheduled_Delivery_Advanced.png

  5. Name your scheduled delivery and set the recurrence frequency and destination on the Settings tab.

    API_Analytics_Data_Scheduled_Delivery_Advanced.png

  6. Review your selections and click Save.

Create Analytics Alerts

You can automate email alerts for any widget in your Analytics dashboard by following the steps below:

  1. Hover over the desired widget.

  2. Click on the Alerts bell icon.

    API_Analytics_Alerts_MRK.png

  3. Configure your alert details in the pop-up window.

    API_Analytics_Alerts.png

  4. Click Save Alert.

Notes About Analytics Data

Please note the following about the data provided on the Analytics pages:

  • Analytics pages ignore orders from inactive stores.

  • Analytics pages ignore Rate Calculator shipments (that is, shipments without orders).

  • Currently, Analytics order counts include the number of shipments contained within an order. This means, if you have split orders into multiple shipments, your order count will reflect the number of shipments within the orders.

Articles in this section

See more
Didn't Find What You Were Looking For? Contact Support