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

Traffic & Engagement

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

Website Analytics

​

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

Website Analytics 操作

Traffic & Engagement

​

Traffic & Engagement. Response follows the SimilarWeb v5 envelope (meta + data). Date constraint: the start_date-end_date span must cover between 1 and 120 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. Default: monthly.

    值
    • monthly
  • metrics
    类型: string
    必填

    Comma-separated metrics, e.g. visits,pages_per_visit.

  • 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). Default: True.

  • mtd
    类型: boolean

    Month-to-date flag (true/false).

响应
  • 200
    类型: object

    SimilarWeb v5 envelope (meta + data).

    • data
      类型: array object[]
      • average_visit_duration
        类型: number
      • bounce_rate
        类型: number
      • date
        类型: string
      • new_users
        类型: number
      • page_views
        类型: number
      • pages_per_visit
        类型: number
      • returning_users
        类型: number
      • unique_visitors
        类型: 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/traffic-engagement
curl 'https://openapi.felo.ai/v1/beta/similarweb/website/traffic-engagement?domain=&start_date=&end_date=&metrics=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "meta": {
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "granularity": "monthly",
      "country": "us",
      "start_date": "2026-06-01",
      "end_date": "2026-06-30",
      "web_source": "total",
      "metrics": [
        "visits",
        "pages_per_visit",
        "average_visit_duration",
        "bounce_rate",
        "new_users",
        "page_views",
        "returning_users",
        "unique_visitors"
      ],
      "state": null,
      "mtd": false,
      "main_domain_only": true
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "date": "2026-06-01",
      "visits": 182538329.78179574,
      "bounce_rate": 0.6402229356798581,
      "average_visit_duration": 194.8333714917004,
      "pages_per_visit": 1.9970684926970637,
      "page_views": 364541547.1167704,
      "unique_visitors": 32705292.619999997,
      "new_users": 10074246.080150243,
      "returning_users": 22631046.540221456
    }
  ]
}

SimilarWeb v5 envelope (meta + data).

Traffic & Engagement