Alerts

Alerts fired for the account

Lists alerts fired in the window, newest first, across the account or for one project, with their message, facts, channel and delivery status. Types: competitor_new (a new advertiser appeared), competitor_returning (an advertiser returned after 30 days away), hijack_detected (an ad mentions the brand in its copy), affiliate_detected (one of your affiliate IDs was detected).

get/alert-events

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/alert-events
  • Auth: HTTP bearer

Query parameters

project_idstring

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

type'competitor_new' | 'competitor_returning' | 'hijack_detected' | 'affiliate_detected' | 'ranking_drop' | 'nklg_re_enable' | 'ingestion_failed' | 'summary_digest'
delivery_status'pending' | 'delivered' | 'failed'
channel'email' | 'webhook' | 'slack'
range'7d' | '14d' | '30d' | '12m' | 'custom'

Window ending today: 7d, 14d, 30d (default) or 12m. Use custom with from and to for fixed dates.

fromstring

First local day, YYYY-MM-DD (custom range).

tostring

Last local day, YYYY-MM-DD, included in full (custom range).

time_zonestring

IANA time zone for day boundaries, such as America/New_York. Defaults to the time zone of the person the credential acts for.

limitinteger

Items per page, 1 to 200.

cursorstring

The next_cursor value from the previous page. Omit it for the first page.

Response

Alerts fired for the account

next_cursorstring nullable required

Pass as cursor to get the next page; null on the last page.

request_idstring

Changes

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