Skip to main content
GET
/
metrics
/
top-institutions
Top-N institutions ranked by count or failure rate
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/metrics/top-institutions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "institution_id": "<string>",
      "institution_name": "<string>",
      "value": 123
    }
  ]
}

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

​
by
enum<string>
default:connection_count

Sort key.

Available options:
connection_count,
failure_rate
​
limit
integer
default:10

Max rows returned (1-50).

Required range: 1 <= x <= 50
​
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

Top-N institutions for the requested sort key.

​
by
enum<string>
required
Available options:
connection_count,
failure_rate
​
data
object[]
required