Usage Alerts
List usage alert configs
Retrieve all usage alert configs for the company, including the company-wide config and any project-scoped configs. Pass project_id to filter to a single project.
GET
List usage alert configs
Authorizations
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Query Parameters
Maximum number of items per page
Required range:
1 <= x <= 100Example:
25
Number of items to skip
Required range:
0 <= x <= 10000Example:
0
Filter to the config scoped to a specific project. Omit to list all configs for the company.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Default Response
List of items
Total number of items matching the query
Required range:
0 <= x <= 10000Example:
42
Current pagination offset
Required range:
0 <= x <= 10000Example:
0
Current pagination limit
Required range:
1 <= x <= 100Example:
25
Previous
Create usage alert configCreate a usage alert config for the company or for a specific project. Each company can have one company-wide config plus one config per project. Configs are evaluated hourly against the current billing period. The highest matching trigger fires once per period and notifies the listed emails.
Next
List usage alert configs