Analytics

Model

All analytics data is returned in a record. The key to the format is the day, in the format of YYYY_MM_DD. The value will be an object fo the resources the analytics are about.

For example:

        const analytics = {
  "2023_01_01": {
    deliveries: {}, //Deliveries analytics
    shipments: {}, //Shipments analytics
    fulfillments: {}, //Fulfillments analytics
    ///...etc
  },
};

      

# Deliveries analytics

These are analytics for deliveries on the platform. You can see on each day, how many deliveries were in which status and what the average hold time was.

Deliveries would be access with analytics[day].deliveries.

hold_time object
The total counts of how long deliveries were attributed to a location and the total number of deliveries that were attributed to a location. This can be used to calculate the average hold time.

statuses object
These are the current counts on this day for each of the delivery statuses