Skip to main content

Domains API

Manage monitored domains programmatically.

List Domains​

GET /domains

Response​

{
  "data": [
    {
      "id": "dom_abc123",
      "url": "https://competitor.com",
      "status": "active",
      "pages_count": 5,
      "last_crawled_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Get Domain​

GET /domains/:id

Response​

{
  "data": {
    "id": "dom_abc123",
    "url": "https://competitor.com",
    "status": "active",
    "pages": [
      {
        "id": "page_xyz789",
        "url": "/pricing",
        "type": "pricing",
        "last_crawled_at": "2024-01-15T10:30:00Z"
      }
    ],
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Add Domain​

POST /domains

Request Body​

{
  "url": "https://competitor.com"
}

Response​

{
  "data": {
    "id": "dom_abc123",
    "url": "https://competitor.com",
    "status": "pending",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Delete Domain​

DELETE /domains/:id

Response​

{
  "data": {
    "deleted": true
  }
}