Document Request Metrics

Get status counts for document requests

/regulatory-documents/requests/metrics

GET https://api.terminal.africa/v1/regulatory-documents/requests/metrics

Returns counts grouped by request status. Uses the same filters as List Document Requests so totals match the filtered list.

Query Parameters

Name	Type	Description
source	String	Filter by source. shipment or invoice.
shipment_id	String	Filter by Terminal shipment id.
tracking_number	String	Filter by carrier tracking number.
search	String	Search across request_id, shipment_id, and tracking_number.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type*	String	Set value to application/json

200: OK Document request metrics retrieved successfully

{
    "status": true,
    "message": "Document request metrics retrieved successfully",
    "data": {
        "total": 42,
        "draft": 10,
        "purchasing": 0,
        "processing": 5,
        "completed": 25,
        "failed": 2
    }
}