データ API / Similarweb / Search

Keyword Competitors

Keyword Competitors. Response follows the SimilarWeb v5 envelope (meta + data).

パラメータ

クエリ

domainstring必須
Target domain, e.g. example.com.
start_datestring必須
Start month, format YYYY-MM.
end_datestring必須
End month, format YYYY-MM.
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
Web source. This endpoint accepts desktop only (the gateway rejects mobile_web and total with 400).
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/search/keyword-competitors" \
  --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": {
      "traffic_source": "organic",
      "format": "json",
      "domain": "cnn.com",
      "granularity": "monthly",
      "country": "us",
      "start_date": "2026-06-01",
      "end_date": "2026-06-30",
      "web_source": "desktop",
      "metrics": [
        "score",
        "shared_keywords"
      ],
      "main_domain_only": false
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "url": "robinhood.com",
      "score": 19.105918884277344,
      "shared_keywords": 0.42673856019973755
    }
  ]
}

レスポンスのフィールド

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[]任意
urlstring任意
scorenumber任意
shared_keywordsnumber任意