`get_vouchers_claim_stats`

Read-only

Calls GET /api/vouchers/claim-stats as the signed-in person · REST reference

Voucher/claim aggregation for the dashboard

By-state voucher counts and values from the DAL's graph aggregation, plus the fields the dashboard reads. Declared before /{id} so the literal path is not captured as a voucher id. Takes no query parameters — the aggregation is platform-wide and is not org-scoped. Money here is integer CENTS, like every other money field on this API. averageSLA is always 'N/A' and monthlyTrends always an empty array: the graph holds no timestamp source for either. todayCount is NOT a count for today — it is the number of vouchers in the claim pipeline (CLAIMED, APPROVED, QUEUED_FOR_CHECKOUT, PAID) regardless of date.

Arguments

This tool takes no arguments.

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_vouchers_claim_stats",
    "arguments": {}
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The aggregation.

json

{
  "averageSLA": "string",
  "byState": [
    {
      "count": 1,
      "state": "string",
      "value": 1
    }
  ],
  "currency": "string",
  "monthlyTrends": [
    {}
  ],
  "todayCount": 1,
  "totalCount": 1,
  "totalValue": 1
}

Fields

Field	Type	Description
`averageSLA`	string	Always the literal 'N/A' — there is no per-claim timestamp source.
`byState`	array of object	Every state the graph holds vouchers in, ordered by count descending.
`byState[].count`	integer
`byState[].state`	string
`byState[].value`	integer	Summed face value in CENTS.
`currency`	string
`monthlyTrends`	array of object	Always empty — there is no per-month source.
`todayCount`	integer	Vouchers in the claim pipeline, all time. Not scoped to today.
`totalCount`	integer
`totalValue`	integer	Summed face value in CENTS.

When it fails

A failed call returns isError: true with the API's message as text.

403: Authenticated, but the caller holds none of the required permissions.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json

{
  "name": "get_vouchers_claim_stats",
  "description": "GET /api/vouchers/claim-stats — By-state voucher counts and values from the DAL's graph aggregation, plus the fields the dashboard reads. Declared before `/{id}` so the literal path is not captured as a voucher id. Takes no query parameters — the aggregation is platform-wide and is not org-scoped. Money here is integer CENTS, like every other money field on this API. `averageSLA` is always 'N/A' and `monthlyTrends` always an empty array: the graph holds no timestamp source for either. `todayCount` is NOT a count for today — it is the number of vouchers in the claim pipeline (CLAIMED, APPROVED, QUEUED_FOR_CHECKOUT, PAID) regardless of date.",
  "inputSchema": {
    "type": "object",
    "properties": {}
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}