Usage

Get usage statistics

get/client/usage/stats

Return verification usage statistics. MEMBER role receives a limited view without API key breakdown.

Authorization

Bearer token in the Authorization header.

Query parameters

startDatestring

endDatestring

Response

totalintegerrequired

byStatusobjectrequired

Show child attributes

successintegerrequired

failedintegerrequired

pendingintegerrequired

errorintegerrequired

byTypeobjectrequired

Show child attributes

accountNumberintegerrequired

phoneNumberintegerrequired

successRatestringrequired

Percentage as string with 2 decimals

last30Daysobject

Show child attributes

totalintegerrequired

byStatusobjectrequired

Show child attributes

successintegerrequired

failedintegerrequired

pendingintegerrequired

errorintegerrequired

byTypeobjectrequired

Show child attributes

accountNumberintegerrequired

phoneNumberintegerrequired

successRatestringrequired

const response = await fetch('https://api.lira.com/api/v1/client/usage/stats', { method: 'GET', headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', }, }); const data = await response.json();

{ "total": 1247, "byStatus": { "success": 1180, "failed": 42, "pending": 5, "error": 20 }, "byType": { "accountNumber": 890, "phoneNumber": 357 }, "successRate": "94.63", "last30Days": { "total": 412, "byStatus": { "success": 395, "failed": 12, "pending": 0, "error": 5 }, "byType": { "accountNumber": 290, "phoneNumber": 122 }, "successRate": "95.87" } }