コンテンツにスキップ

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.

id
required
string format: uuid

Project UUID.

Array of alert rules.

object
success
boolean
data
Array<object>

Alert rule with joined display names and latest status.

object
id
string format: uuid
name
string
mapId
string format: uuid
mapName

Display name of the associated map (joined).

string | null
thresholdProfileId
string format: uuid
thresholdProfileName

Display name of the threshold profile (joined).

string | null
metric
string
Allowed values: fps frame_time memory gpu_time
thresholdLevel
string
Allowed values: warn good
failPercentage

Percentage of cells that must fail to trigger (1-100).

number
evaluationDays

Number of days of data to evaluate.

integer
cellSize

Grid cell size used for evaluation.

integer
cooldownMinutes

Minimum minutes between notifications.

integer
isActive
boolean
createdAt
string format: date-time
latestStatus

Status from the most recent evaluation (triggered or resolved).

string | null
channelIds

Notification channel UUIDs.

Array<string>
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.

object
success
boolean
error

Human-readable error message.

string

Resource not found.

object
success
boolean
error

Human-readable error message.

string

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string
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.