Felo API PlatformFelo API Platform
Wszystkie endpointy Similarweb
v0.2.0-beta
OpenAPI 3.1.0
Serwer:https://openapi.felo.ai
Biblioteki klienckie

Website Analytics

​

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

SimilarSites

​

SimilarSites. Odpowiedź jest zgodna z kopertą SimilarWeb v5 (meta + data). Zakres dat (ograniczenie dostawcy upstream SimilarWeb): start_date i end_date muszą obejmować DOKŁADNIE 3 kolejne miesiące — zakres 1 lub 2 miesięcy jest odrzucany z błędem upstream 120 („must span exactly 3 month(s)”). Zakres ten musi też być najnowszym obsługiwanym przedziałem SimilarWeb, który przesuwa się z każdym miesiącem; starszy lub wykraczający poza zakres przedział jest odrzucany z błędem 101 („Dates not in range”). W praktyce żądaj trzech ostatnich zakończonych miesięcy (np. jeśli najnowszy opublikowany miesiąc to 2026-07, użyj start_date=2026-05 i end_date=2026-07). Aby odczytać dokładny aktualnie obsługiwany zakres, wywołaj endpoint /describe SimilarWeb dla tego API.

Cennik referencyjny

  • Rozliczanie: liczba naliczonych wyników.
  • Szacunek referencyjny dla żądania: USD 0.375.
  • Podstawa kosztu jednostkowego: USD 0.075.
  • Jednostka zasobu: similarweb_credit.
  • Referencyjny mnożnik klienta: 1.0. Nie stosuj go ponownie do rozliczonej kwoty klienta.
  • Podstawy kosztu nie ustalają ostatecznej ceny dla klienta, również gdy wynoszą zero.

Wyłącznie metadane referencyjne, a nie wycena konta, gwarantowana cena lub limit wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Parametry zapytania
  • country
    enum
    const:  
    ww

    Wyłącznie dane ogólnoświatowe; wartości nie rozróżniają wielkości liter.

    wartości
    • ww
  • domain
    Typ: string
    min. długość:  
    1
    maks. długość:  
    253
    wymagane
  • end_date
    Typ: string
    wymagane
  • granularity
    enum
    const:  
    monthly
    wartości
    • monthly
  • limit
    Typ: integer
    min.:  
    1
    maks.:  
    20
    wymagane

    Integer numbers.

  • main_domain_only
    Typ: boolean
  • offset
    Typ: integer
    min.:  
    0
    maks.:  
    100000

    Integer numbers.

  • start_date
    Typ: string
    wymagane
  • traffic_source
    Typ: string
  • web_source
    Typ: string enum
    wartości
    • desktop
    • mobile_web
    • total
Odpowiedzi
  • 200
    Typ: object

    Koperta SimilarWeb v5 (meta + data).

    • data
      Typ: array object[]
      • affinity
        Typ: number
      • category
        Typ: string
      • domain
        Typ: string
      • has_adsense
        Typ: boolean
      • rank
        Typ: integer

        Integer numbers.

    • meta
      Typ: object · Response7B51F63Afd06_SimilarWebMeta

      Metadane koperty odpowiedzi SimilarWeb v5.

      • status
        Typ: string
        wymagane

        Status upstream; 'success' przy udanym wywołaniu.

      • last_updated
        Typ: string

        Data najnowszego punktu danych dostępnego upstream (YYYY-MM-DD).

      • query
        Typ: object

        Echo paginacji/sortowania, gdy ma zastosowanie (limit, offset, asc, sort).

      • request
        Typ: object

        Pełne echo znormalizowanego żądania upstream (parametry w postaci otrzymanej).

    application/json
  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Odpowiedź błędu; odpowiedzi przekazywane bezpośrednio od dostawcy upstream mogą używać formatów dostawcy

    application/json
Request Example for get/v1/beta/similarweb/website/similar-sites
curl 'https://openapi.felo.ai/v1/beta/similarweb/website/similar-sites?domain=cnn.com&end_date=2026-09&limit=1&start_date=2026-07' \
  --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