Shipping Metrics

GET /tms/shipping-metrics

Description

This endpoint retrieves shipping metrics based on various filter criteria. You can get detailed shipping metrics by specifying parameters such as tenant ID, country code, date range, and various filtering options.

Parameters

• tenantId (string, header, required): The ID of the tenant.
• countryCode (string, header, required): The code representing the country.
• from (string, query, required): The start date for the metrics query (in ISO 8601 format).
• to (string, query, required): The end date for the metrics query (in ISO 8601 format).
• groupBy (array[string], query, optional): Criteria to group the metrics by. Available values are TENANT_ID, REQUEST_REFERENCE, DRIVER_USER_ID, VEHICLE_ID, DROP_OFF_CONTACT, DROP_OFF_EMAIL, COUNTRY_CODE, ORDER_ID.
• filterByTenantId (array[string], query, optional): Filter results by tenant IDs.
• filterByCountryCode (array[string], query, optional): Filter results by country codes.
• filterByDriverUserId (array[string], query, optional): Filter results by driver user IDs.
• filterByRequestReference (array[string], query, optional): Filter results by request references.
• filterByDropOffContact (array[string], query, optional): Filter results by drop-off contacts.
• filterByDropOffEmail (array[string], query, optional): Filter results by drop-off emails.
• filterByOrderId (array[string], query, optional): Filter results by order IDs.
• filterByVehicleId (array[string], query, optional): Filter results by vehicle IDs.
• isAssigned (boolean, query, optional): Filter results based on whether the shipping is assigned.

Responses

• 200 OK
  • Media Type: Controls Accept header.
  • Example Value:

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}