データ API / Similarweb / Search

Website Keywords

Website Keywords. Response follows the SimilarWeb v5 envelope (meta + data). Date constraint: the start_date-end_date span must cover between 1 and 3 monthly buckets.

パラメータ

クエリ

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任意
指定できる値： total
Traffic source device split. Allowed: total.
main_domain_onlyboolean任意
Restrict to the main domain only (true/false).
formatstring任意
指定できる値： json
Response format. Allowed: json.

リクエスト例

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

レスポンス

レスポンス例

{
  "meta": {
    "query": {
      "limit": 5,
      "offset": 0,
      "asc": null,
      "sort": null
    },
    "request": {
      "branded_type": "all",
      "keywords_filter_rules": [],
      "format": "json",
      "domain": "nike.com",
      "granularity": "monthly",
      "country": "us",
      "start_date": "2026-06-01",
      "end_date": "2026-06-30",
      "traffic_source": "all",
      "web_source": "total",
      "metrics": [
        "clicks",
        "traffic_share",
        "competition",
        "primary_intent",
        "secondary_intent",
        "position",
        "serp_features",
        "top_url",
        "url_count"
      ]
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "keyword": "nike",
      "clicks": 1001887.5658500849,
      "traffic_share": 0.15853772273003125,
      "competition": 100,
      "primary_intent": "Navigational",
      "secondary_intent": null,
      "position": 1,
      "serp_features": [
        "organic_sitelinks",
        "organic_expanded_sitelinks",
        "apps",
        "pla",
        "images",
        "related_searches",
        "popular_products",
        "paid_sitelinks",
        "paid",
        "news",
        "video",
        "organic",
        "local_pack",
        "related_questions"
      ],
      "top_url": "nike.com",
      "url_count": 1581
    }
  ]
}

レスポンスのフィールド

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[]任意
keywordstring任意
clicksnumber任意
traffic_sharenumber任意
competitioninteger任意
primary_intentstring任意
secondary_intent任意
positioninteger任意
serp_features任意
top_urlstring任意
url_countinteger任意