Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0
伺服器:https://openapi.felo.ai
用戶端程式庫

Website Analytics

​

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

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.

查詢參數
  • domain
    類型: string
    必填

    Target domain, e.g. example.com.

  • start_date
    類型: string
    必填

    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_date
    類型: string
    必填

    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).

  • 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
    類型: string 列舉

    Traffic source device split. Allowed: desktop, mobile_web, total.

    值
    • desktop
    • mobile_web
    • total
  • main_domain_only
    類型: boolean

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

  • offset
    類型: integer

    Row offset for pagination.

  • traffic_source
    類型: string

    Traffic-source filter.

回應
  • 200
    類型: object

    SimilarWeb v5 envelope (meta + data).

    • data
      類型: array object[]
      • affinity
        類型: number
      • category
        類型: string
      • domain
        類型: string
      • has_adsense
        類型: boolean
      • rank
        類型: 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/website/similar-sites
curl 'https://openapi.felo.ai/v1/beta/similarweb/website/similar-sites?domain=&start_date=&end_date=&limit=20' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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
    }
  ]
}
SimilarSites