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

User's validation time series

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

Returns a time series for the user by the selected range and metric. Bucket granularity varies with range: 24h → hourly, 7d/30d → daily, 90d → weekly (starting Monday). Metric volume breaks down direct vs OCR; latency returns p50, p95, and p99 percentiles.

Parameters
ParameterInTypeRequiredDescription
metricquerystringoptional

Which series to return. volume is how many validations there were; latency, how long they took. The second rising without the first points at the provider, not at traffic.

Default: volume

e.g. volume
rangequerystringoptional

Window the series cover: 24h a day, 7d a week, 30d a month, and 90d a quarter. The bucket 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 buckets 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 — user's validations only; global — all platform validations (admin 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 buckets for the requested range and metric.No body
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
c4d5e6f7a8b9
403forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0