Alerts

One alert rule

Returns one alert rule: type, channel, destination (email address or URL host only), restrictions and whether it is enabled. The signing secret is not returned; rotate_webhook_secret issues a new one.

get/alert-rules/{rule_id}

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/alert-rules/{rule_id}
  • Auth: HTTP bearer

Path parameters

rule_idstring required

The alert rule id from list_alert_rules.

Response

One alert rule

idstring required
project_idstring nullable required
project_namestring nullable required
brand_namestring required
type'competitor_new' | 'competitor_returning' | 'hijack_detected' | 'affiliate_detected' | 'ranking_drop' | 'nklg_re_enable' | 'ingestion_failed' | 'summary_digest' required
type_labelstring required
channel'email' | 'webhook' | 'slack' required
destinationstring nullable required

Email address, or the host of a webhook or Slack URL (the full URL is never returned). null for an email rule that goes to the account owner.

enabledboolean required
created_atstring required
request_idstring

Changes

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