コンテンツにスキップ
Framedash Docs

Create an alert rule

POST
/v1/projects/{id}/alerts

Creates a new performance alert rule for the project. The rule monitors a specific metric on a map and triggers notifications when the failure percentage exceeds the threshold.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Project UUID.

Request Body required

Section titled “Request Body required ”
object
name
required
string
mapId
required
string format: uuid
thresholdProfileId
required
string format: uuid
metric
required
string
Allowed values: fps frame_time memory gpu_time
thresholdLevel
required
string
Allowed values: warn good
failPercentage
required
number
>= 1 <= 100
evaluationDays
required
integer
cellSize
required
integer
Allowed values: 5 10 25 50
cooldownMinutes
required
integer
>= 1
channelIds
Array<string>

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Alert rule created.

object
success
boolean
data

Full alert rule including timestamps and channel IDs.

object
id
string format: uuid
projectId
string format: uuid
mapId
string format: uuid
thresholdProfileId
string format: uuid
name
string
metric
string
Allowed values: fps frame_time memory gpu_time
thresholdLevel
string
Allowed values: warn good
failPercentage
number
evaluationDays
integer
cellSize
integer
cooldownMinutes
integer
isActive
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
channelIds
Array<string>

400

Section titled “400 ”

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

401

Section titled “401 ”

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

403

Section titled “403 ”

Plan limit reached or feature not available.

object
success
boolean
error

Human-readable error message.

string

404

Section titled “404 ”

Resource not found.

object
success
boolean
error

Human-readable error message.

string

429

Section titled “429 ”

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string

Headers

Section titled “Headers ”
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.