DICT keys-summary report (COUNT-only)

Returns COUNT(*) buckets grouped by (keyType, status) over PIX keys registered in a mandatory date window (max 92 days). COUNT-only — DICT holds no money. Raw key values are never returned.

GET /api/v1/dict/reports/keys-summary

DICT keys-summary report (COUNT-only)

cURL

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/reports/keys-summary \
  --header 'Authorization: Bearer <token>'

200

{
  "buckets": [
    {
      "count": 123,
      "keyType": "<string>",
      "status": "<string>",
      "participantISPB": "<string>"
    }
  ],
  "countOnly": true,
  "window": {
    "fromDate": "<string>",
    "toDate": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

fromDate · string · required

Inclusive start of the report window (YYYY-MM-DD UTC). Required.

Example:

"2026-06-01"

toDate · string · required

Inclusive end of the report window (YYYY-MM-DD UTC). Required. The window may not exceed 92 days.

Example:

"2026-06-30"

groupByParticipant · boolean

Optional: when true, adds the per-indirect-participant dimension to the COUNT(*) GROUP BY. COUNT-only either way.

Example:

false

Response

200

application/json

OK

buckets · object[] | null · required

COUNT(*) buckets grouped by (keyType, status) over keys registered in the window.

Show child attributes

countOnly · boolean · required

Always true — DICT summaries are COUNT-only (no monetary field).

Example:

true

window · object · required

Echo of the resolved report window.

Show child attributes