Interface PlaceAlertQueryOptions

Mapping of available query parameters for the alerts index endpoint

interface PlaceAlertQueryOptions {
    _poll?: boolean;
    alert_dashboard_id?: string;
    alert_type?: string;
    cache?: number;
    enabled?: boolean;
    fields?: string;
    limit?: number;
    offset?: number;
    q?: string;
    ref?: string;
    severity?: string;
}

Hierarchy (View Summary)

Properties

_poll? alert_dashboard_id? alert_type? cache? enabled? fields? limit? offset? q? ref? severity?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalalert_dashboard_id

alert_dashboard_id?: string

Return alerts for a specific dashboard

Optionalalert_type

alert_type?: string

Filter by alert type

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalenabled

enabled?: boolean

Filter by enabled status

Optionalfields

fields?: string

Deprecated

Ignored by the server since PlaceOS moved search to PostgreSQL (PPT-2644)

Optionallimit

limit?: number

Number of results to return. Defaults to 20. Max 10000

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalq

q?: string

Free-text search filter. Words match as prefixes against the resource's searchable fields (PostgreSQL full-text search); all words must match.

Optionalref

ref?: string

Deprecated

Ignored by the server; pagination follows the Link header's offset

Optionalseverity

severity?: string

Filter by alert severity

Settings

Member Visibility

On This Page

Properties