GEThttps://api.veriko.mx/v1/insights/top-banks

List the account's banks by validation volume or error rate

Audience
public
Auth
API key
Permission
insights:read_self
How-to guide →

Lists the banks used in the authenticated user's validations over the last 30 days, ranked by total volume or by error rate.

Parameters
ParameterInTypeRequiredDescription
limitqueryintegeroptional

Filter — Maximum number of banks to return.

Default: 10

e.g. 10
metricquerystringoptional

Filter — Sorting criterion. volume puts the banks with the most validations on top; errors, those with the highest error rate.

Default: volume

e.g. volume
Request
curl -X GET 'https://api.veriko.mx/v1/insights/top-banks' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200InsightsTopBanksAttributes — User's banks ordered by the requested metric over the last 30 days.
FieldTypeDescription
metricstring

Ranking metric — volume: banks ordered by validation count; errors: banks ordered by error rate.

e.g. volume
scopestring

Data scope — self: Only the authenticated user's validations; global: All platform validations (administrators only).

e.g. self
banksarray

List of banks ordered by the selected metric.

Response status codesGET /v1/insights/top-banks
StatusClassDescriptionBody
2002xxUser's banks ordered by the requested metric over the last 30 days.InsightsTopBanksAttributes
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Errors from GET /v1/insights/top-banks
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d