資料 API / Similarweb / Website

SimilarSites

SimilarSites. Response follows the SimilarWeb v5 envelope (meta + data). Date window (upstream SimilarWeb constraint): start_date and end_date must span EXACTLY 3 consecutive months — a 1- or 2-month span is rejected with upstream error 120 ('must span exactly 3 month(s)'). That span must also be SimilarWeb's most recent supported window, which advances forward each month; an older or out-of-range span is rejected with error 101 ('Dates not in range'). In practice, request the three most recent completed months (e.g. if the latest published month is 2026-07, use start_date=2026-05 and end_date=2026-07). To read the exact currently-supported range, call SimilarWeb's /describe endpoint for this API.

參數

查詢

domainstring必填
Target domain, e.g. example.com.
start_datestring必填
Start month, format YYYY-MM. Must be exactly 2 months before end_date: the window has to span exactly 3 consecutive months within SimilarWeb's latest supported range (see the endpoint description).
end_datestring必填
End month, format YYYY-MM. Together with start_date must span exactly 3 consecutive months, and must be the most recent supported month (the window rolls forward monthly; see the endpoint description).
granularitystring選填
允許值： monthly
Time granularity. Allowed: monthly.
limitinteger必填
Number of rows to return; max 20, billed as 20 if exceeded.
countrystring選填
允許值： us · ww
Two-letter country code. Allowed: us, ww. Default: ww. Coverage is limited to ww and us on the current plan.
web_sourcestring選填
允許值： desktop · mobile_web · total
Traffic source device split. Allowed: desktop, mobile_web, total.
main_domain_onlyboolean選填
Restrict to the main domain only (true/false).
offsetinteger選填
Row offset for pagination.
traffic_sourcestring選填
Traffic-source filter.

請求範例

curl -G "https://openapi.felo.ai/v1/beta/similarweb/website/similar-sites" \
  --data-urlencode "domain=<string>" \
  --data-urlencode "start_date=<string>" \
  --data-urlencode "end_date=<string>" \
  --data-urlencode "limit=<integer>" \
  -H "Authorization: Bearer $FELO_API_KEY"

回應

回應範例

{
  "meta": {
    "query": {
      "limit": 5,
      "offset": 0,
      "asc": null,
      "sort": null
    },
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "granularity": "monthly",
      "start_date": "2026-05-01",
      "end_date": "2026-07-31",
      "metrics": [
        "rank",
        "affinity",
        "has_adsense"
      ],
      "category": null
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "domain": "bbc.com",
      "category": "News_and_Media",
      "rank": 95,
      "affinity": 1,
      "has_adsense": true
    }
  ]
}

回應欄位

metaobject選填
SimilarWeb v5 response envelope metadata.
statusstring必填
Operation status; success for a successful lookup.
last_updatedstring選填
Date of the most recent available data point (YYYY-MM-DD).
requestobject選填
Normalized request parameters used for this lookup.
queryobject選填
Pagination/sort echo when applicable (limit, offset, asc, sort).
dataobject[]選填
domainstring選填
categorystring選填
rankinteger選填
affinitynumber選填
has_adsenseboolean選填