Usage summary
curl --request GET \
--url https://api.privue.ai/usage/v1/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privue.ai/usage/v1/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privue.ai/usage/v1/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"start": "2026-09-01",
"end": "2026-09-30",
"total_calls": 250,
"billed_calls": 244,
"uncharged_calls": 6,
"credits_spent": 752,
"credits_remaining": 4248,
"by_operation": [
{
"operation": "bank.penny-drop.1",
"version": "v1",
"calls": 40,
"billed_calls": 37,
"uncharged_calls": 3,
"credits_spent": 148
},
{
"operation": "bundle.business",
"version": "v1",
"calls": 10,
"billed_calls": 10,
"uncharged_calls": 0,
"credits_spent": 210
},
{
"operation": "gst.gst-info.1",
"version": "v1",
"calls": 120,
"billed_calls": 118,
"uncharged_calls": 2,
"credits_spent": 236
},
{
"operation": "pan.verify.3",
"version": "v1",
"calls": 80,
"billed_calls": 79,
"uncharged_calls": 1,
"credits_spent": 158
}
]
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}Usage
Usage summary
Total your calls over a period, broken down by endpoint, with your remaining credits.
GET
/
usage
/
v1
/
summary
Usage summary
curl --request GET \
--url https://api.privue.ai/usage/v1/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privue.ai/usage/v1/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privue.ai/usage/v1/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"start": "2026-09-01",
"end": "2026-09-30",
"total_calls": 250,
"billed_calls": 244,
"uncharged_calls": 6,
"credits_spent": 752,
"credits_remaining": 4248,
"by_operation": [
{
"operation": "bank.penny-drop.1",
"version": "v1",
"calls": 40,
"billed_calls": 37,
"uncharged_calls": 3,
"credits_spent": 148
},
{
"operation": "bundle.business",
"version": "v1",
"calls": 10,
"billed_calls": 10,
"uncharged_calls": 0,
"credits_spent": 210
},
{
"operation": "gst.gst-info.1",
"version": "v1",
"calls": 120,
"billed_calls": 118,
"uncharged_calls": 2,
"credits_spent": 236
},
{
"operation": "pan.verify.3",
"version": "v1",
"calls": 80,
"billed_calls": 79,
"uncharged_calls": 1,
"credits_spent": 158
}
]
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}Authorizations
Your API key, sent as Authorization: Bearer <your-key>.
Query Parameters
First day to count, inclusive
Last day to count, inclusive
Response
Successful Response
Totals for a period, with the credit balance as it stands now.
First day counted, inclusive
Last day counted, inclusive
Calls made over the period, successful or not
Calls that were charged
Calls that cost nothing, whether they failed or answered without reaching a conclusion
Credits deducted over the period, across every endpoint
Credits left on the key that made this request, null when it has no limit
The same totals, broken down by endpoint
Show child attributes
Show child attributes
