Usages

Retrieve list of shipments called with the API

Retrieve the list of shipments called with the API within the provided timeframe, that usages have a minimum resolution of a month (you cant select the usage for one week for example, the usage will automatically be for the month of the week provided)

get/shipment-usage

Request

  • Base URL
    https://api.sinay.ai/webhook/api/v1
  • URL
    https://api.sinay.ai/webhook/api/v1/shipment-usage
  • Auth
    API key in header API_KEY

Query parameters

startTimestring date-time
Example:2024-06-12T12:00:00Z

Start time at which usages must be found

endTimestring date-time
Example:2024-06-12T12:00:00Z

End time at which usages must be found

periodicity'DAILY' | 'MONTHLY'

Response

Usage has been recovered

apisShipmentCustomUsagesApis

Changes

No recorded changes to this operation across all 1 revision of this API.