Get comprehensive dashboard metrics

Use this endpoint to retrieve complete dashboard metrics including summary, trends, and breakdowns for the Command Center.

GET /v1/reports/contexts/{contextId}/dashboard/metrics

Get comprehensive dashboard metrics

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics \
  --header 'Authorization: Bearer <token>'

200

{
  "breakdowns": {
    "byAge": [
      {
        "bucket": "<string>",
        "value": 123
      }
    ],
    "byReason": {},
    "byRule": [
      {
        "count": 123,
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "bySeverity": {}
  },
  "summary": {
    "criticalExposure": "<string>",
    "matchRate": 123,
    "oldestExceptionAgeHours": 123,
    "pendingExceptions": 123,
    "totalMatches": 123,
    "totalTransactions": 123
  },
  "trends": {
    "dates": [
      "<string>"
    ],
    "exceptions": [
      123
    ],
    "ingestion": [
      123
    ],
    "matchRates": [
      123
    ],
    "matches": [
      123
    ]
  },
  "updatedAt": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

Path Parameters

contextId · string · required

The unique identifier of the reconciliation context.

Query Parameters

date_from · string · required

Start date (YYYY-MM-DD)

date_to · string · required

End date (YYYY-MM-DD)

source_id · string

Source ID filter

Response

200

application/json

Indicates that the request was successful and the response contains the expected data.

breakdowns · object

Show child attributes

summary · object

Show child attributes

trends · object

Show child attributes

updatedAt · string