Skip to Content
veriom

Get usage alert settings

Report the processing and plan-limit alert settings and the thresholds reached this month.

GET
/v1/workspaces/{workspace_id}/usage-alerts

Report the processing and plan-limit alert settings and the thresholds reached this month.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
can_manage*Can Manage

Whether the caller may change the settings.

customer_reached?array<>

Thresholds of the cap on the workspace's own model keys reached this month (metric customer_model_spend); kept apart from the plan's alerts.

customer_spend_cap_usd?|

Monthly cap on spend through the workspace's own model keys; null for none.

email_enabled*Email Enabled
in_app_enabled*In App Enabled
limit_metrics*array<>
limit_thresholds*array<integer>
period*Period

The UTC month the reached alerts belong to (YYYY-MM).

reached*array<>

Thresholds of the plan's processing allowance and limits reached this month, by metric and threshold.

spend_thresholds*array<integer>
updated_at*|null
version*Version

0 while the workspace uses the default settings.

Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage-alerts'
Example Response
{  "can_manage": true,  "customer_reached": [    {      "limit": "string",      "metric": "model_spend",      "notified": true,      "reached_at": "2019-08-24T14:15:22Z",      "threshold": 0,      "used": "string"    }  ],  "customer_spend_cap_usd": "string",  "email_enabled": true,  "in_app_enabled": true,  "limit_metrics": [    "repositories"  ],  "limit_thresholds": [    0  ],  "period": "string",  "reached": [    {      "limit": "string",      "metric": "model_spend",      "notified": true,      "reached_at": "2019-08-24T14:15:22Z",      "threshold": 0,      "used": "string"    }  ],  "spend_thresholds": [    0  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}