Visibility change alerts from your trackers

Returns the change events your trackers detected between scheduled runs — when your brand is dropped from or added to a prompt, its position moves, a competitor newly appears, or sentiment shifts. Poll this to react to visibility changes. Free.

GET/v1/alerts/

Authorization

accessKey

x-access-key<token>

In: header

Query Parameters

brand_id?string

type?string

Value in"mention_lost" | "mention_gained" | "position_changed" | "competitor_new" | "sentiment_changed"

from?string

to?string

limit?integer

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/"

{
  "success": true,
  "data": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "alerts": [
      {
        "id": "string",
        "brandId": "string",
        "brand": "string",
        "trackerId": "string",
        "prompt": "string",
        "engine": "string",
        "type": "string",
        "message": "string",
        "createdAt": "string"
      }
    ]
  }
}

{
  "success": false,
  "message": "string"
}

{
  "success": false,
  "message": "string"
}

{
  "success": false,
  "message": "string"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`