REST API

Competitors

List tracked competitors and ask to track new ones.

List competitors

GET/api/competitorsscope: read
curl https://www.zieads.com/api/competitors \
  -H "Authorization: Bearer zk_your_key"
Response 200
{
  "data": {
    "competitors": [
      {
        "id": "c1...",
        "name": "Kopi Senja",
        "website_url": "https://kopisenja.id",
        "instagram_username": "kopisenja",
        "content_stats": {
          "ads_active": 6,
          "posts": 120
        }
      }
    ]
  }
}

Track a competitor

POST/api/competitorsscope: draft
Body
namestringrequired
Brand name.
website_urlstring
Website.
instagram_usernamestring
With or without @.
curl -X POST https://www.zieads.com/api/competitors \
  -H "Authorization: Bearer zk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"Kopi Senja","instagram_username":"kopisenja"}'
Response 201
{
  "data": {
    "task_id": "9b42...",
    "status": "pending_approval",
    "message": "Waiting for approval in ZieAds (AI Analyst or the approvals list)."
  }
}