GEThttps://api.veriko.mx/v1/usage/breakdown

Desglosar consumo por operación

Audiencia
public
Autenticación
API key
Permiso
usage:read_self
Guía de uso →

Desglosa el consumo del periodo indicado por tipo de operación contabilizada (validation y sms_2fa).

El parámetro period acepta current para el mes en curso o una cadena YYYY-MM para un mes específico.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
periodquerystringopcional

Período a desglosar. Acepta current para el mes en curso o una cadena YYYY-MM para un mes específico.

p. ej. current
Petición
curl -X GET 'https://api.veriko.mx/v1/usage/breakdown' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200GetUsageBreakdownAttributes — Conteos de consumo por tipo de operación para el período solicitado.
CampoTipoDescripción
dataobject

Cuerpo de la respuesta, en la envoltura JSON:API.

typestring

Tipo de recurso JSON:API. Siempre usage_breakdown.

p. ej. usage_breakdown
attributesobject

Datos del desglose: el periodo y el consumo por operación.

periodstring

Mes al que corresponde el desglose, en formato YYYY-MM.

p. ej. 2026-04
operationsarray

Una entrada por tipo de operación, con lo que consumió cada una.

Códigos de respuestaGET /v1/usage/breakdown
CódigoClaseDescripciónCuerpo
2002xxConteos de consumo por tipo de operación para el período solicitado.GetUsageBreakdownAttributes
4004xxEl formato del parámetro period no es válido.ErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Errores de GET /v1/usage/breakdown
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d