v0.2.0-beta

OpenAPI 3.1.0

Subdomény

Felo API Support

MIT

Server

https://openapi.felo.ai

Klientské knihovny

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operace

post/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live

Subdomény

Subdomény target a vyhledávací stopa každé z nich. Stránkování přes limit, offset a offset_token; po prvních stránkách používejte token. Zabaleno do obálky DataForSEO: data v tasks[0].result, výsledek v tasks[0].status_code – odmítnutý požadavek stále vrací HTTP 200. Užitečné, když se provoz domény soustředí jinde než na www – subdoména dokumentace nebo blogu, která web nese, je v post_dataforseo_labs_google_domain_rank_overview_live neviditelná.

Cenová reference

Účtování: nahlášené náklady na odpověď.
Referenční odhad požadavku: USD 0.1356.
Referenční multiplikátor zákazníka: 1.0. Neaplikujte jej znovu na zúčtovanou částku zákazníka.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Tělo

application/json

Typ: array (object | null)[]
- filters
  Typ: array (object | null)[] | null
  
  pole parametrů filtrování výsledků
  volitelné pole
  můžete přidat několik filtrů najednou (maximálně 8)
  mezi podmínkami je nutné nastavit logický operátor and, or
  podporované operátory:
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in
  příklad:
  ["metrics.paid.count",">",0]
  
  [["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]
  
  [["metrics.organic.count",">","10"], "and", [["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]
  další informace o filtrech naleznete v Dataforseo Labs - Filters nebo v tomto průvodci centra nápovědy
  
  Prázdný objekt
- historical_serp_mode
  Typ: string | null
  
  režim sběru dat
  volitelné pole
  toto pole můžete použít k filtrování výsledků;
  možné typy filtrování:
  live — vrací metriky pro SERPy, ve kterých má zadaný target aktuálně výsledky umístění;
  lost — vrací metriky pro SERPy, ve kterých měl zadaný target dříve výsledky umístění, ale při poslední kontrole je neměl;
  all — vrací metriky pro oba typy SERPů.
  výchozí hodnota: live
- ignore_synonyms
  Typ: boolean | null
  
  ignorovat velmi podobná klíčová slova
  volitelné pole
  pokud je nastaveno na true, vrátí se pouze základní klíčová slova a všechna velmi podobná klíčová slova budou vyloučena;
  výchozí hodnota: false
- include_clickstream_data
  Typ: boolean | null
  
  zahrnutí nebo vyloučení dat z metrik založených na clickstreamu ve výsledku
  volitelné pole
  pokud je parametr nastaven na true, v odpovědi obdržíte pole clickstream_etv, clickstream_gender_distribution a clickstream_age_distribution s daty z clickstreamu
  výchozí hodnota: false
  povolením tohoto parametru se cena za požadavek zdvojnásobí
  
  další informace o tom, jak se metriky založené na clickstreamu počítají, najdete v tomto článku centra nápovědy
- item_types
  Typ: array string[] | null
  
  zobrazení výsledků podle typu položky
  volitelné pole
  určuje typ výsledků vyhledávání zahrnutých v odpovědi
  
  Poznámka: pokud pole item_types obsahuje typy položek odlišné od organic, budou výsledky seřazeny podle prvního typu položky v poli; výsledky nebude možné řadit ani filtrovat podle typů výsledků vyhledávání, které nejsou v odpovědi zahrnuty;
  
  možné hodnoty:
  ["organic", "paid", "featured_snippet", "local_pack"]
  výchozí hodnota:
  ["organic", "paid"]
- language_code
  Typ: string | null
  
  kód jazyka
  volitelné pole
  pokud toto pole použijete, nemusíte zadávat language_name
  seznam dostupných jazyků a jejich language_code získáte odesláním samostatného požadavku na
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  toto pole ignorujte, chcete-li získat výsledky pro všechny dostupné jazyky
  příklad:
  en
- language_name
  Typ: string | null
  
  úplný název jazyka
  volitelné pole
  pokud toto pole použijete, nemusíte zadávat language_code
  seznam dostupných jazyků a jejich language_name získáte odesláním samostatného požadavku na
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  toto pole ignorujte, chcete-li získat výsledky pro všechny dostupné jazyky
  příklad:
  English
- limit
  Typ: integer | null
  
  maximální počet vrácených klíčových slov
  volitelné pole
  výchozí hodnota: 100
  maximální hodnota: 1000
- location_code
  Typ: integer | null
  
  kód lokality
  volitelné pole
  pokud toto pole použijete, nemusíte zadávat location_name
  seznam dostupných lokalit a jejich location_code získáte odesláním samostatného požadavku na
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  toto pole ignorujte, chcete-li získat výsledky pro všechny dostupné lokality
  příklad:
  2840
- location_name
  Typ: string | null
  
  úplný název lokality
  volitelné pole
  pokud toto pole použijete, nemusíte zadávat location_code
  seznam dostupných lokalit a jejich location_name získáte odesláním samostatného požadavku na
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  toto pole ignorujte, chcete-li získat výsledky pro všechny dostupné lokality
  příklad:
  United Kingdom
- offset
  Typ: integer | null
  
  posun v poli výsledků vrácených klíčových slov
  volitelné pole
  výchozí hodnota: 0
  pokud zadáte hodnotu 10, prvních deset klíčových slov v poli výsledků bude vynecháno a data budou poskytnuta pro následující klíčová slova
- order_by
  Typ: array string[] | null
  
  pravidla řazení výsledků
  volitelné pole
  k řazení výsledků můžete použít stejné hodnoty jako v poli filters
  možné typy řazení:
  asc — výsledky budou seřazeny vzestupně
  desc — výsledky budou seřazeny sestupně
  typ řazení se nastavuje čárkou
  příklad:
  ["metrics.paid.etv,asc"]
  Poznámka: v jednom požadavku lze nastavit nejvýše tři pravidla řazení
  několik pravidel řazení je nutné oddělit čárkou
  příklad:
  ["metrics.organic.etv,desc","metrics.paid.count,asc"]
  
  výchozí pravidlo:
  ["metrics.organic.count,desc"]
  Poznámka: pokud pole item_types obsahuje typy položek odlišné od organic, budou výsledky seřazeny podle prvního typu položky v poli
- tag
  Typ: string | null
  
  uživatelem definovaný identifikátor úlohy
  volitelné pole
  limit znaků je 255
  tento parametr můžete použít k identifikaci úlohy a jejímu spárování s výsledkem
  zadanou hodnotu tag najdete v objektu data odpovědi
- target
  Typ: string
  
  doména
  povinné pole
  název domény cílového webu
  doménu je nutné zadat bez https:// a www.

Odpovědi

200
Typ: object | null · Response36Afe1097B20_DataforseoLabsGoogleSubdomainsLiveResponseInfo
cost
Typ: number | null Formát: double

celkové náklady na úlohy, USD

status_code
Typ: integer | null

obecný kód stavu úplný seznam kódů odpovědí najdete zde

status_message
Typ: string | null

obecná informační zpráva úplný seznam obecných informačních zpráv najdete zde

tasks
Typ: array (object | null)[] | null

pole úloh

Typ: object | null · Response36Afe1097B20_DataforseoLabsGoogleSubdomainsLiveTaskInfo
cost
Typ: number | null Formát: double

celkové náklady na úlohy, USD

data
Typ: object | null

obsahuje stejné parametry, které jste zadali v požadavku POST

propertyName
Typ: object | null
id
Typ: string | null

identifikátor úlohy jedinečný identifikátor úlohy v našem systému ve formátu UUID

path
Typ: array (string | null)[] | null

cesta URL

result
Typ: array (object | null)[] | null

pole výsledků

items
Typ: array (object | null)[] | null

obsahuje subdomény a související data

metrics
Typ: object | null

rankingová data týkající se subdomény

propertyName
Typ: object · Response36Afe1097B20_DataforseoLabsMetricsInfo
clickstream_age_distribution
Typ: object | null

rozložení metrik založených na clickstreamu podle věku
pro získání výsledků tohoto pole musí být parametr include_clickstream_data nastaven na true
více o tom, jak se metrika počítá, najdete v tomto článku nápovědy

propertyName
Typ: integer | null Formát: int64

Signed 64-bit integers (long type).

clickstream_etv
Typ: number | null Formát: double

odhadovaný objem návštěvnosti na základě dat clickstreamu
počítá se jako součin hodnot míry prokliku a objemu vyhledávání z clickstreamu všech klíčových slov, na která se doména umisťuje
pro získání výsledků tohoto pole musí být parametr include_clickstream_data nastaven na true
více o tom, jak se metrika počítá, najdete v tomto článku nápovědy

clickstream_gender_distribution
Typ: object | null

rozložení odhadovaných metrik založených na clickstreamu podle pohlaví
pro získání výsledků tohoto pole musí být parametr include_clickstream_data nastaven na true
více o tom, jak se metrika počítá, najdete v tomto článku nápovědy

propertyName
Typ: integer | null Formát: int64

Signed 64-bit integers (long type).

count
Typ: integer | null Formát: int64

celkový počet organických SERP obsahujících doménu nebo subdoménu

estimated_paid_traffic_cost
Typ: number | null

odhadované náklady na převod organické návštěvnosti na placenou
představuje odhadované měsíční náklady (USD) na reklamu pro všechna klíčová slova v kategorii, na která se doména nebo subdoména umisťuje
metrika se počítá jako součin hodnot organického etv a placeného cpc a udává náklady na přivedení odhadovaného objemu měsíční organické návštěvnosti prostřednictvím reklamy PPC ve Vyhledávání Google
více o tom, jak se metrika počítá, najdete v tomto článku nápovědy

etv
Typ: number | null

odhadovaný objem návštěvnosti
odhadovaná organická měsíční návštěvnost domény nebo subdomény
počítá se jako součin hodnot CTR (míry prokliku) a objemu vyhledávání všech klíčových slov v kategorii, na která se doména nebo subdoména umisťuje
více o tom, jak se metrika počítá, najdete v tomto článku nápovědy

is_down
Typ: integer | null

rank klesl
udává, kolik rankingových prvků uvedeného cíle kleslo

is_lost
Typ: integer | null

ztracené rankingové prvky
udává, kolik rankingových prvků uvedeného cíle bylo dříve zobrazeno v SERP, ale při poslední kontrole nebyly nalezeny

is_new
Typ: integer | null

počet nových rankingových prvků
udává, kolik nových rankingových prvků bylo nalezeno pro uvedený cíl

is_up
Typ: integer | null

rank stoupl
udává, kolik rankingových prvků uvedeného cíle stouplo

pos_1
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #1

pos_11_20
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #11-20

pos_2_3
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #2-3

pos_21_30
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #21-30

pos_31_40
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #31-40

pos_4_10
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #4-10

pos_41_50
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #41-50

pos_51_60
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #51-60

pos_61_70
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #61-70

pos_71_80
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #71-80

pos_81_90
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #81-90

pos_91_100
Typ: integer | null

počet organických SERP, kde se doména nebo subdoména umisťuje na #91-100

se_type
Typ: string | null

typ vyhledávače

subdomain
Typ: string | null

vrácená subdoména

items_count
Typ: integer | null Formát: int64

počet výsledků vrácených v poli items

language_code
Typ: string | null

kód jazyka v poli POST

location_code
Typ: integer | null

kód lokality v poli POST

se_type
Typ: string | null

typ vyhledávače

target
Typ: string | null

doména v poli POST

total_count
Typ: integer | null Formát: int64

celkový počet výsledků v naší databázi relevantních pro váš požadavek

result_count
Typ: integer | null Formát: int64

počet prvků v poli result

status_code
Typ: integer | null

stavový kód úlohy vygenerovaný DataForSEO; může být v následujícím rozsahu: 10000-60000 úplný seznam kódů odpovědí najdete zde

status_message
Typ: string | null

informační zpráva úlohy úplný seznam obecných informačních zpráv najdete zde

time
Typ: string | null

doba provedení, sekundy

tasks_count
Typ: integer | null Formát: int64

počet úloh v poli tasks

tasks_error
Typ: integer | null Formát: int64

počet úloh v poli tasks vrácených s chybou

time
Typ: string | null

celková doba provádění, sekundy

version
Typ: string | null

aktuální verze API
application/json
400

Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.
401

Je vyžadován platný API klíč Felo.
402

V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.
403

Účet nemá oprávnění tuto operaci provést.
429

Byl dosažen limit požadavků nebo útraty.
502

Služba nemohla požadavek dokončit.
503

API nebo fakturační služba je dočasně nedostupná.
504

Při zpracování požadavku vypršel časový limit služby.
default

Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

application/json

post/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ]
  }
]'

Zobrazit schéma

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "se_type": null,
          "target": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "subdomain": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}

Úspěšná operace

Subdomény

OvěřováníRequired

DataForSEO

Subdomény

Cenová reference