Skip to main content
GET
/
metrics
/
summary
Headline counts for the portal tile grid
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/metrics/summary \
  --header 'Authorization: Bearer <token>'
{
  "total_clients": 1,
  "active_connections": 1,
  "linked_accounts": 1,
  "statements_in_period": 1,
  "transactions_in_period": 1,
  "stale_accounts_count": 1
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Query Parameters

​
from
string<date-time>

Inclusive lower bound (ISO-8601 timestamp). Defaults to now - 30 days when omitted.

​
to
string<date-time>

Exclusive upper bound (ISO-8601 timestamp). Defaults to now when omitted.

Response

Aggregated counts.

​
total_clients
integer<int64>
required

All-time clients created under this customer + environment.

Required range: x >= 0
​
active_connections
integer<int64>
required

Connections currently in an active state.

Required range: x >= 0
​
linked_accounts
integer<int64>
required

Accounts attached to any active connection.

Required range: x >= 0
​
statements_in_period
integer<int64>
required

Statements created in the requested window.

Required range: x >= 0
​
transactions_in_period
integer<int64>
required

Transactions created in the requested window.

Required range: x >= 0
​
stale_accounts_count
integer<int64>
required

Accounts flagged by the proactive-staleness job (NEEDS_REAUTH, FAILING, CATCHUP_EXHAUSTED, STALE_NOT_POLLED, or SKIPPED_INACTIVE_BANK).

Required range: x >= 0