GEThttps://api.veriko.mx/v1/insights/trends

Get the account's validation time series

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

Returns a time series representing the authenticated user's validations, according to the selected range and metric.

The interval size varies with the range:

  • 24h: hourly.
  • 7d and 30d: daily.
  • 90d: weekly, starting on Monday.

The volume metric breaks down into manual (direct) and OCR (ocr) validations.

The latency metric returns the p50, p95, and p99 percentiles.

Parameters
ParameterInTypeRequiredDescription
metricquerystringoptional

Filter — Series to return. With volume, each point contains the validation count; with latency, the processing-time percentiles for validations that have that measurement.

Default: volume

e.g. volume
rangequerystringoptional

Filter — Time window covered by the series: 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days), or 90d (last 90 days). The interval size scales with the window, so two queries over different windows are not comparable point by point.

Default: 7d

e.g. 7d
Request
curl -X GET 'https://api.veriko.mx/v1/insights/trends' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200InsightsTrendsAttributes — Time-series intervals for the requested range and metric.
FieldTypeDescription
rangestring

Time window of the series: 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days), or 90d (last 90 days).

e.g. 7d
metricstring

Metric represented — volume: validation counts stacked by type; latency: processing times in percentiles.

e.g. volume
scopestring

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

e.g. self
seriesarray

Data points in chronological order. The shape of each point depends on metric: for volume it includes bucket, total, direct, ocr, valid, errored; for latency it includes bucket, p50, p95, p99, avg.

Response status codesGET /v1/insights/trends
StatusClassDescriptionBody
2002xxTime-series intervals for the requested range and metric.InsightsTrendsAttributes
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Errors from GET /v1/insights/trends
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