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

Referrals

Felo API Support
MIT
サーバー:https://openapi.felo.ai
クライアントライブラリ
Shell Curl

Website Analytics

​

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

Website Analytics 操作

Referrals

​

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

クエリパラメーター
  • 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
    型: 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[]
      • change
        型: number
      • domain
        型: string
      • share
        型: number
      • visits
        型: number
    • 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/referrals
curl 'https://openapi.felo.ai/v1/beta/similarweb/website/referrals?domain=&start_date=&end_date=&limit=20' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "meta": {
    "query": {
      "limit": 5,
      "offset": 0,
      "asc": null,
      "sort": null
    },
    "request": {
      "referral_type": "incoming",
      "format": "json",
      "domain": "cnn.com",
      "granularity": "monthly",
      "country": "us",
      "start_date": "2026-06-01",
      "end_date": "2026-06-30",
      "web_source": "total",
      "main_domain_only": false
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "domain": "citizenfreepress.com",
      "share": 0.1664343819749612,
      "change": 0.44941053996464486,
      "visits": 1083633.5339702675
    }
  ]
}

SimilarWeb v5 envelope (meta + data).

Referrals