docs / endpoint

POST /v1/domains/overview

Return a domain's organic and paid search overview for one market.

Credits: 10 credits per call. Timeout: 60s

Parameters

NameTypeRequiredDefaultDescription
domain string required — Domain to look up (bare hostname, e.g. example.com). Required, max 253 chars.
location any optional 2840 Google Ads geotarget ID, an ISO country code (e.g. "US"), or a country name. Optional, default 2840 (United States). Look one up with /v1/locations.
language string optional "en" ISO language code. Optional, default "en".

Request

→ requestPOST /v1/domains/overview
POST /v1/domains/overview HTTP/1.1
Authorization: Bearer sof_live_your_key_here
Content-Type: application/json

{
  "domain": "example.com",
  "location": 2840,
  "language": "en"
}

Response

The usual envelope (id, request_id, object, created_at, elapsed_ms, credits) is documented once on The Contract. Below is an example response with this endpoint's data. Values vary per request; … marks an array cut short.

← response200
{
  "id": "doma_l5sttkwwhbltpdaj4ocitm6l",
  "request_id": "req_vglyeybggrlz7kagqfagvj4kiy",
  "object": "domain_overview",
  "created_at": "2026-07-29T12:00:00Z",
  "elapsed_ms": 244,
  "credits": {
    "charged": 10,
    "balance": 9857
  },
  "data": {
    "organic": {
      "keywords_count": 101,
      "traffic_estimate": 70.17,
      "traffic_value": 704.38,
      "positions": {
        "top_3": 0,
        "top_10": 3,
        "top_20": 11,
        "top_100": 101
      }
    },
    "paid": {
      "keywords_count": 0,
      "traffic_estimate": 0,
      "traffic_value": 0,
      "positions": {
        "top_3": 0,
        "top_10": 0,
        "top_20": 0,
        "top_100": 0
      }
    }
  }
}

Response fields

What each field in data (above) means.

FieldDescription
data.organic Organic (unpaid) search metrics for the requested market.
data.organic.keywords_count Number of keywords the domain ranks for organically.
data.organic.traffic_estimate Estimated monthly organic traffic.
data.organic.traffic_value Estimated monthly value of that traffic at prevailing CPC.
data.organic.positions Cumulative keyword counts ranking in the top 3/10/20/100 positions.
data.organic.positions.top_3 Keywords ranking in positions 1-3.
data.organic.positions.top_10 Keywords ranking in positions 1-10.
data.organic.positions.top_20 Keywords ranking in positions 1-20.
data.organic.positions.top_100 Keywords ranking in positions 1-100.
data.paid Paid (ads) search metrics for the requested market, same shape as organic.
data.paid.keywords_count Number of keywords the domain has paid ads ranking for.
data.paid.traffic_estimate Estimated monthly paid-ads traffic.
data.paid.traffic_value Estimated monthly value of that traffic at prevailing CPC.
data.paid.positions Cumulative keyword counts ranking in the top 3/10/20/100 positions.
data.paid.positions.top_3 Keywords ranking in positions 1-3.
data.paid.positions.top_10 Keywords ranking in positions 1-10.
data.paid.positions.top_20 Keywords ranking in positions 1-20.
data.paid.positions.top_100 Keywords ranking in positions 1-100.