Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Website Keywords

Felo API Support
MIT
服务器:https://openapi.felo.ai
客户端库
Shell Curl

Website Analytics

​

Website traffic, engagement, audience, rankings and search data.

Website Analytics 操作

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.

查询参数
  • domain
    类型: string
    必填

    Target domain, e.g. example.com.

  • start_date
    类型: string
    必填

    Start month, format YYYY-MM.

  • end_date
    类型: string
    必填

    End month, format YYYY-MM.

  • granularity
    枚举
    常量:  
    monthly
    必填

    Time granularity. Allowed: monthly.

    值
    • monthly
  • limit
    类型: integer
    最大值:  
    20
    必填

    Number of rows to return; max 20, billed as 20 if exceeded.

  • country
    类型: string 枚举

    Two-letter country code. Allowed: us, ww. Default: ww. Coverage is limited to ww and us on the current plan.

    值
    • us
    • ww
  • web_source
    枚举
    常量:  
    total

    Traffic source device split. Allowed: total.

    值
    • total
  • main_domain_only
    类型: boolean

    Restrict to the main domain only (true/false).

  • format
    枚举
    常量:  
    json

    Response format. Allowed: json.

    值
    • json
响应
  • 200
    类型: object

    SimilarWeb v5 envelope (meta + data).

    • data
      类型: array object[]
      • clicks
        类型: number
      • competition
        类型: integer

        Integer numbers.

      • keyword
        类型: string
      • position
        类型: integer

        Integer numbers.

      • primary_intent
        类型: string
      • secondary_intent
        类型: string | null
      • serp_features
        类型: array string[] | string
      • top_url
        类型: string
      • traffic_share
        类型: number
      • url_count
        类型: integer

        Integer numbers.

    • meta
      类型: object · SimilarWebMeta

      SimilarWeb v5 response envelope metadata.

      • status
        类型: string
        必填

        Operation status; success for a successful lookup.

      • last_updated
        类型: string

        Date of the most recent available data point (YYYY-MM-DD).

      • query
        类型: object

        Pagination/sort echo when applicable (limit, offset, asc, sort).

      • request
        类型: object

        Normalized request parameters used for this lookup.

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for get/v1/beta/similarweb/search/website-keywords
curl 'https://openapi.felo.ai/v1/beta/similarweb/search/website-keywords?domain=&start_date=&end_date=&granularity=monthly&limit=20' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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
    }
  ]
}

SimilarWeb v5 envelope (meta + data).

Website Keywords