コンテンツにスキップ

List alert evaluation history

GET
/v1/projects/{id}/alerts/history

Returns the evaluation history for all alert rules in the project, ordered by most recent first. Use pagination via limit and offset.

id
required
string format: uuid

Project UUID.

limit
integer
default: 50 >= 1 <= 100

Maximum number of events to return.

offset
integer
0

Number of events to skip for pagination.

Array of alert evaluation events.

object
success
boolean
data
Array<object>

Record of a single alert rule evaluation.

object
id
string format: uuid
alertRuleId
string format: uuid
ruleName

Name of the alert rule at time of evaluation.

string
metric
string
status

Evaluation result.

string
Allowed values: triggered resolved
failCount

Number of cells that failed the threshold.

integer
totalCount

Total number of cells evaluated.

integer
failPercentage

Actual failure percentage.

number
notified

Whether a notification was sent for this evaluation.

boolean
createdAt
string format: date-time
thresholdProfileId

Threshold profile this event was evaluated against. Null when that profile has since been deleted (the event is retained and labeled rather than reattributed to the rule’s current primary profile).

string | null format: uuid
thresholdProfileName

Threshold profile name (joined); null when the profile has since been deleted.

string | null
thresholdProfileDeleted

True when the evaluated threshold profile has since been deleted (its id and name are null).

boolean
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

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
type
required

Problem type URI; about:blank when no specific type applies.

string format: uri
default: about:blank
title
required

Short, human-readable summary of the problem type.

string
status
required

HTTP status code.

integer
detail

Human-readable explanation specific to this occurrence.

string
error_category

Extension member categorizing the error.

string
Allowed values: authentication authorization validation rate_limit not_found conflict payload internal
retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean
retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

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
type
required

Problem type URI; about:blank when no specific type applies.

string format: uri
default: about:blank
title
required

Short, human-readable summary of the problem type.

string
status
required

HTTP status code.

integer
detail

Human-readable explanation specific to this occurrence.

string
error_category

Extension member categorizing the error.

string
Allowed values: authentication authorization validation rate_limit not_found conflict payload internal
retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean
retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

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
type
required

Problem type URI; about:blank when no specific type applies.

string format: uri
default: about:blank
title
required

Short, human-readable summary of the problem type.

string
status
required

HTTP status code.

integer
detail

Human-readable explanation specific to this occurrence.

string
error_category

Extension member categorizing the error.

string
Allowed values: authentication authorization validation rate_limit not_found conflict payload internal
retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean
retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.

Retry-After
integer

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.