Sign in
Alert

Read

Retrieve a single Alert record by ID.

get/api/cp/alert/{id}

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

company_idinteger

Company Id (references company.id)

titlestring

Title

areastring

Area

operator'<' | '<=' | '=' | '>' | '>=' | 'always'

Operator

thresholdnumber

Threshold

reset_thresholdnumber

Reset Threshold

sample_periodinteger

Sample Period

recipientstring

Recipient

templatestring

Template

state'Paused' | 'Ready' | 'Fired' | 'Sent' | 'Simulate'

State

penaltyinteger

Penalty

reset_timeoutstring date-time

Reset Timeout

cronstring

Cron

sandbox_idinteger

Sandbox Id

last_ranstring date-time nullable

Last Ran

next_runstring date-time

Next Run

tagstring

Tag

notice_level'none' | 'warning' | 'error'

Notice Level

table_changestring

Table Change

querystring

Query

Example response

{
  "id": 12345,
  "company_id": 1,
  "title": "Example Name",
  "area": "example_area",
  "operator": "<",
  "threshold": 99.99,
  "reset_threshold": 99.99,
  "sample_period": 123,
  "recipient": "example_recipient",
  "template": "example_template",
  "state": "Paused",
  "penalty": 123,
  "reset_timeout": "2025-01-17T10:30:00Z",
  "cron": "example_cron",
  "sandbox_id": 1,
  "last_ran": "2025-01-17T10:30:00Z",
  "next_run": "2025-01-17T10:30:00Z",
  "tag": "example_tag",
  "notice_level": "none",
  "table_change": "example_table_change",
  "query": "Sample query text content"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.