Watchlist

Add or update a watchlist item by page_url

Upsert behaviour: if a watchlist item already exists for the given page_url it is updated (status 200 OK), otherwise created (status 201 Created). Requires scope watchlist:write.

post/api/v1/watchlist

Request

  • Base URL: https://getscaleforge.com
  • URL: https://getscaleforge.com/api/v1/watchlist
  • Auth: HTTP bearer

Request body

Response

Existing item updated

updatedboolean

Example response

{
  "watchlist_item": {
    "id": 17,
    "page_url": "https://www.facebook.com/ads/library/?active_status=active&ad_type=all&view_all_page_id=100012345",
    "page_name": "Competitor Page",
    "page_id": "100012345",
    "scan_frequency": "daily",
    "active": true,
    "total_ads": 42,
    "active_ads": 42
  },
  "updated": true
}

Changes

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