curl --request GET \
--url https://api.watchdog.no/v1/usage \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"period": "<string>",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"unit": "invoice",
"consumed": 123,
"consumption_only": true,
"policy_cadence": "calendar_month",
"allowance": 123,
"overage": 123,
"policy_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capacity": {
"eligible": true,
"remaining": 123,
"reason": "available",
"reserved": 123,
"as_of": "2023-11-07T05:31:56Z"
}
}
],
"next_cursor": "<string>",
"current_capacity": {
"eligible": true,
"remaining": 123,
"reason": "available",
"reserved": 123,
"as_of": "2023-11-07T05:31:56Z",
"cadence": "calendar_month",
"anchor_date": "2023-12-25",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"period": "<string>",
"billing_timezone": "<string>",
"counted": 123,
"allowance": 123,
"overage": 123,
"policy_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}List usage by billing period
Returns usage per billing month, newest first: the current month by default, or up to 12 months with period_from and period_through. current_capacity shows usage, allowance and overage for the whole current policy period.
curl --request GET \
--url https://api.watchdog.no/v1/usage \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"period": "<string>",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"unit": "invoice",
"consumed": 123,
"consumption_only": true,
"policy_cadence": "calendar_month",
"allowance": 123,
"overage": 123,
"policy_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capacity": {
"eligible": true,
"remaining": 123,
"reason": "available",
"reserved": 123,
"as_of": "2023-11-07T05:31:56Z"
}
}
],
"next_cursor": "<string>",
"current_capacity": {
"eligible": true,
"remaining": 123,
"reason": "available",
"reserved": 123,
"as_of": "2023-11-07T05:31:56Z",
"cadence": "calendar_month",
"anchor_date": "2023-12-25",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"period": "<string>",
"billing_timezone": "<string>",
"counted": 123,
"allowance": 123,
"overage": 123,
"policy_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Query Parameters
Return only these fields of each row, comma-separated; use dots for nested fields, such as capacity.eligible. Fields: period, period_start, period_end, unit, consumed, consumption_only, policy_cadence, allowance, overage, policy_revision_id, capacity.
Maximum number of results per page.
1 <= x <= 1000Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.
4096^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$