コンテンツにスキップ

List threshold profiles

GET
/v1/projects/{id}/threshold-profiles

Returns the threshold profiles for the specified project, ordered newest first. Use these IDs as thresholdProfileId when creating alert rules.

id
required
string format: uuid

Project UUID.

Array of threshold profiles.

object
success
boolean
data
Array<object>

Performance threshold profile used by alert rules.

object
id
required
string format: uuid
name
required
string
platform
required

Optional platform filter; null matches any platform.

string | null
resolution
required

Optional resolution filter, such as 1920x1080; null matches any resolution.

string | null
buildConfig
required

Optional build configuration filter; null matches any build configuration.

string | null
gpu
required

Optional GPU model filter; null matches any GPU.

string | null
storage
required

Optional storage type filter; null matches any storage.

string | null
fpsGood
required

Good threshold for FPS.

number | null
fpsWarn
required

Warning threshold for FPS.

number | null
frameTimeGood
required

Good threshold for frame time in milliseconds.

number | null
frameTimeWarn
required

Warning threshold for frame time in milliseconds.

number | null
memoryGood
required

Good threshold for memory usage in megabytes (MB).

number | null
memoryWarn
required

Warning threshold for memory usage in megabytes (MB).

number | null
gpuTimeGood
required

Good threshold for GPU time in milliseconds.

number | null
gpuTimeWarn
required

Warning threshold for GPU time in milliseconds.

number | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
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.