---
title: "Retrieve list of shipments called with the API, 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)"
method: GET
path: "/shipment-usage"
tags: ["Usage"]
---

# Retrieve list of shipments called with the API, 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/container-tracking/api/v2`
- URL: `https://api.sinay.ai/container-tracking/api/v2/shipment-usage`
- Auth: API key in header `API_KEY`
- TypeScript: <https://skmtc.dev/sinay/apis/api-container-tracking/docs/shipment-usage/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `startTime` string, date-time
- `endTime` string, date-time
- `periodicity` 'DAILY' | 'MONTHLY'

## Response `200`

Usage has been recovered

- ShipmentCustomUsages
  - `apis` ShipmentCustomUsagesApis

## Other responses

- `401`: The authentication failed
- `500`: An error occurred on server side
- `default`: default

---

[API](https://skmtc.dev/sinay/apis/api-container-tracking.md) - [All operations](https://skmtc.dev/sinay/apis/api-container-tracking/llms.txt) - [OpenAPI document](https://skmtc.dev/sinay/apis/api-container-tracking/revisions/c62d97358d47?raw)