List alert rules
GET /v1/projects/{id}/alerts
Returns all alert rules for the specified project, including joined map names, threshold profile names, latest evaluation status, and notification channel IDs.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Project UUID.
Responses
Section titled “ Responses ”Array of alert rules.
object
Alert rule with joined display names and latest status.
object
Display name of the associated map (joined).
Display name of the threshold profile (joined).
Percentage of cells that must fail to trigger (1-100).
Number of days of data to evaluate.
Grid cell size used for evaluation.
Minimum minutes between notifications.
Status from the most recent evaluation (triggered or resolved).
The rule’s effective threshold profile bundle (1 to 10 profiles),
each evaluated independently. The first element is the primary profile
(thresholdProfileId).
Per-profile evaluation status and device filters, one entry per member
of thresholdProfileIds. The rule-level latestStatus is triggered
if any member is triggered, else resolved if any is resolved, else null.
Latest evaluation status and device filters for one profile in an alert rule’s bundle.
object
Display name of the profile; null if the profile was deleted.
Latest status for this rule-profile pair, or null if it has not been evaluated yet.
Profile platform filter; null matches any platform.
Profile resolution filter; null matches any resolution.
Profile build configuration filter; null matches any build configuration.
Profile GPU model filter; null matches any GPU.
Profile storage type filter; null matches any storage.
Notification channel UUIDs.
Headers
Section titled “Headers ”Maximum number of requests allowed per hour.
Number of requests remaining in the current window.
Unix timestamp when the rate limit window resets.
Missing or invalid API key.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Resource not found.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Rate limit exceeded.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Headers
Section titled “Headers ”Maximum number of requests allowed per hour.
Number of requests remaining in the current window.
Unix timestamp when the rate limit window resets.
Number of seconds to wait before retrying. Present only on 429
responses. Because the limit uses a sliding window, honor this value
per response rather than scheduling a retry for the reset time.