v0.2.0-beta

OpenAPI 3.1.0

Configurer des tâches OnPage

Felo API Support

MIT

Serveur

https://openapi.felo.ai

Bibliothèques clientes

Shell Curl

DataForSEO

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

DataForSEO Opérations

post/v1/beta/dataforseo/on_page/task_post

Configurer des tâches OnPage

Démarre un crawl de target et renvoie un id de tâche dans tasks[0].id — cet id est la référence dont tous les autres outils de cette famille ont besoin, conservez-le. max_crawl_pages borne le crawl ; start_url, max_crawl_depth, priority_urls et crawl_delay le façonnent ; et store_raw_html décide si post_dataforseo_on_page_raw_html aura quelque chose à servir plus tard. Enveloppé dans l'enveloppe DataForSEO : les données dans tasks[0].result, l'issue dans tasks[0].status_code — une requête rejetée renvoie tout de même HTTP 200. ⚠️ Ce n'est pas la paire habituelle soumission/récupération : le crawl est une session qu'une douzaine d'autres outils interrogent ensuite par id. Interrogez get_dataforseo_on_page_summary en boucle jusqu'à ce que crawl_progress indique finished ; un crawl d'une page d'example.com a pris bien moins d'une minute.

Référence tarifaire

Mesure : coût de réponse déclaré.
Estimation de référence par requête : USD 0.003.
Multiplicateur client de référence : 1.0. Ne pas l'appliquer à nouveau à un montant client déjà réglé.

Métadonnées de référence uniquement, et non un devis de compte, un prix garanti ou un plafond de dépenses. Les crédits de ressources ne sont pas des crédits Felo. Les débits définitifs suivent les enregistrements de facturation Felo.

Corps

application/json

Type: array (object | null)[]
- accept_language
 Type: string | null
 
 en-tête de langue pour accéder au site web
 champ facultatif
 tous les formats de paramètres régionaux sont pris en charge (xx, xx-XX, xxx-XX, etc.)
 Remarque : si vous ne spécifiez pas ce paramètre, certains sites web peuvent refuser l'accès ; dans ce cas, les pages seront renvoyées avec "type":"broken dans le tableau de réponse
- allow_subdomains
 Type: boolean | null
 
 inclure les pages des sous-domaines
 champ facultatif
 définissez sur true si vous voulez explorer tous les sous-domaines d'un site web cible
 valeur par défaut : false
- allowed_subdomains
 Type: array string[] | null
 
 sous-domaines à explorer
 champ facultatif
 indiquez les sous-domaines que vous voulez explorer
 exemple : ["blog.site.com", "my.site.com", "shop.site.com"]
 Remarque : pour utiliser ce paramètre, le paramètre allow_subdomains doit être défini sur false ;
 sinon, le contenu du champ allowed_subdomains sera ignoré et les résultats seront renvoyés pour tous les sous-domaines
- browser_preset
 Type: string | null
 
 préréglage des paramètres d'écran du navigateur
 champ facultatif
 si vous utilisez ce champ, vous n'avez pas besoin d'indiquer browser_screen_width, browser_screen_height, browser_screen_scale_factorvaleurs possibles :
 desktop, mobile, tabletle préréglage desktop applique les valeurs suivantes :browser_screen_width: 1920
 browser_screen_height: 1080
 browser_screen_scale_factor: 1le préréglage mobile applique les valeurs suivantes :browser_screen_width: 390
 browser_screen_height: 844
 browser_screen_scale_factor: 3le préréglage tablet applique les valeurs suivantes :browser_screen_width: 1024
 browser_screen_height: 1366
 browser_screen_scale_factor: 2
 Remarque : pour utiliser ce paramètre, définissez enable_javascript ou enable_browser_rendering sur true
- browser_screen_height
 Type: integer | null
 
 hauteur d'écran du navigateur
 champ facultatif
 vous pouvez définir une hauteur d'écran de navigateur personnalisée pour auditer un appareil particulier ;
 si vous utilisez ce champ, vous n'avez pas besoin d'indiquer browser_preset, car il sera ignoré ;
 Remarque : pour utiliser ce paramètre, définissez enable_javascript ou enable_browser_rendering sur truevaleur minimale, en pixels : 240
 valeur maximale, en pixels : 9999
- browser_screen_scale_factor
 Type: number | null
 
 facteur d'échelle d'écran du navigateur
 champ facultatif
 vous pouvez définir un ratio de résolution d'écran de navigateur personnalisé pour auditer un appareil particulier ;
 si vous utilisez ce champ, vous n'avez pas besoin d'indiquer browser_preset, car il sera ignoré ;
 Remarque : pour utiliser ce paramètre, définissez enable_javascript ou enable_browser_rendering sur truevaleur minimale : 0.5
 valeur maximale : 3
- browser_screen_width
 Type: integer | null Format: int64
 
 largeur d'écran du navigateur
 champ facultatif
 vous pouvez définir une largeur d'écran de navigateur personnalisée pour auditer un appareil particulier ;
 si vous utilisez ce champ, vous n'avez pas besoin d'indiquer browser_preset, car il sera ignoré ;
 Remarque : pour utiliser ce paramètre, définissez enable_javascript ou enable_browser_rendering sur truevaleur minimale, en pixels : 240
 valeur maximale, en pixels : 9999
- calculate_keyword_density
 Type: boolean | null
 
 calculer la densité de mots-clés pour le domaine cible
 champ facultatif
 définissez sur true si vous voulez calculer la densité de mots-clés des pages du site web
 valeur par défaut : false
 Remarque : si vous utilisez ce paramètre, des frais supplémentaires s'appliquent ; en savoir plus sur le coût des tâches avec ce paramètre dans notre article d'aide
 une fois l'exploration terminée, vous pouvez obtenir les valeurs de densité de mots-clés avec le point de terminaison Keyword Density
- check_spell
 Type: boolean | null
 
 vérifier l'orthographe
 champ facultatif
 définissez sur true pour vérifier l'orthographe d'un site web à l'aide de la bibliothèque Hunspell
 valeur par défaut : false
- check_spell_exceptions
 Type: array string[] | null
 
 mots exclus de la vérification orthographique
 champ facultatif
 indiquez les mots que vous voulez exclure de la vérification orthographique
 longueur maximale d'un mot : 100 caractères
 nombre maximal de mots : 1000
 exemple : "SERP", "minifiers", "JavaScript"
- check_spell_language
 Type: string | null
 
 langue de la vérification orthographique
 champ facultatif
 langues prises en charge : 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'
 Remarque : si aucune langue n'est spécifiée, elle sera définie automatiquement en fonction du contenu de la page
- checks_threshold
 Type: object | null
 
 valeurs de seuil personnalisées pour les contrôles
 champ facultatif
 vous pouvez spécifier des valeurs de seuil personnalisées pour les paramètres inclus dans l'objet checks des réponses de l'API OnPage ;
 Remarque : seules les valeurs de seuil entières peuvent être modifiées ;
 par exemple, les paramètres high_loading_time et large_page_size sont définis respectivement sur 3 secondes et 1 mégaoctet par défaut ;
 si vous voulez modifier ces seuils pour 1 seconde et 1000 kbytes, utilisez l'extrait suivant :
 "checks_threshold": { "high_loading_time": 1, "large_page_size": 1000 }
 paramètres personnalisables disponibles avec leurs valeurs par défaut :
 "title_too_short", default value: 30, type: "int" "title_too_long", default value: 65, type: "int" "small_page_size", default value: 1024, type: "int" "large_page_size", default value: 1048576 (1024 * 1024), type: "int" "low_character_count", default value: 1024, type: "int" "high_character_count", default value: 256000 (250 * 1024), type: "int" "low_content_rate", default value: 0.1, type: "float" "high_content_rate", default value: 0.9, type: "float" "high_loading_time", default value: 3000, type: "int" "high_waiting_time", default value: 1500, type: "int" "low_readability_rate", default value: 15.0, type: "float" "irrelevant_description", default value: 0.2, type: "float" "irrelevant_title", default value: 0.3, type: "float" "irrelevant_meta_keywords", default value: 0.6, type: "float"
 
 propertyName
 Type: integer | null Format: int64
 
 Signed 64-bit integers (long type).
- crawl_delay
 Type: integer | null
 
 délai entre les accès, ms
 champ facultatif
 le délai personnalisé entre les accès du robot d'exploration au serveur
 valeur par défaut : 2000
- crawl_sitemap_only
 Type: boolean | null
 
 explorer uniquement les pages indiquées dans le sitemap
 champ facultatif
 définissez-le sur true si vous souhaitez explorer uniquement les pages indiquées dans le sitemap
 si vous définissez ce paramètre sur true sans spécifier custom_sitemap, nous explorerons le sitemap par défaut
 valeur par défaut : false
 Remarque : pour utiliser ce paramètre, respect_sitemap doit être true
- custom_js
 Type: string | null
 
 javascript personnalisé
 champ facultatif
 Remarque : le temps d'exécution du script saisi ici doit être de 700 ms maximum ; par exemple, vous pouvez utiliser l'extrait JS suivant pour vérifier si le site web contient Google Tag Manager en tant qu'attribut scr :
 let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;La valeur renvoyée dépend de ce que vous avez spécifié dans ce champ. Par exemple, si vous spécifiez le script suivant :
 meta = {}; meta.url = document.URL; meta.test = 'test'; meta;
 vous recevrez les données suivantes en réponse :
 "custom_js_response": { "url": "https://dataforseo.com/", "test": "test" }
 Remarque : la longueur du script saisi ne doit pas dépasser 2000 caractères
- custom_robots_txt
 Type: string | null
 
 paramètres robots.txt personnalisés
 champ facultatif
 exemple : Disallow: /directory1/
- custom_sitemap
 Type: string | null
 
 url du sitemap personnalisé
 champ facultatif
 l'URL de la page où se trouve le sitemap alternatif
 Remarque : pour utiliser ce paramètre, respect_sitemap doit être true
- custom_user_agent
 Type: string | null
 
 user agent personnalisé
 champ facultatif
 user agent personnalisé pour explorer un site web
 exemple : Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
 valeur par défaut : Mozilla/5.0 (compatible; RSiteAuditor)
- disable_cookie_popup
 Type: boolean | null
 
 désactiver la fenêtre contextuelle des cookies
 champ facultatif
 définissez-le sur true si vous souhaitez désactiver la fenêtre contextuelle demandant le consentement aux cookies de l'utilisateur ;
 valeur par défaut :
 false
- disable_page_checks
 Type: array string[] | null
 
 empêcher l'exécution de certains contrôles de page
 champ facultatif
 indiquez certains checks pour empêcher leur exécution et leur incidence sur le onpage_scoreexemple :
 "disable_page_checks": ["is_5xx_code", "is_4xx_code"]
- disable_sitewide_checks
 Type: array string[] | null
 
 empêcher l'exécution de certains contrôles sur l'ensemble du site
 champ facultatif
 indiquez les checks suivants pour empêcher leur exécution sur le site web target :
 "test_page_not_found"
 "test_canonicalization"
 "test_https_redirect"
 "test_directory_browsing"exemple :
 "disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]en savoir plus sur notre centre d'aide
- disallowed_subdomains
 Type: array string[] | null
 
 sous-domaines à ne pas explorer
 champ facultatif
 indiquez les sous-domaines que vous ne souhaitez pas explorer
 exemple : ["status.site.com", "docs.site.com"]
 Remarque : pour utiliser ce paramètre, le paramètre allow_subdomains doit être défini sur true
- enable_browser_rendering
 Type: boolean | null
 
 émuler le rendu du navigateur pour mesurer les Core Web Vitals
 champ facultatif
 ce paramètre vous permet d'émuler un navigateur lors du chargement d'une page web ;
 enable_browser_rendering charge les styles, images, polices, animations, vidéos et autres ressources d'une page ;
 valeur par défaut : false
 définissez-le sur true pour obtenir les métriques Core Web Vitals (FID, CLS, LCP) dans la réponse ;
 si vous utilisez ce champ, les paramètres enable_javascript et load_resources doivent être définis sur true
 Remarque : si vous utilisez ce paramètre, des frais supplémentaires s'appliquent ; en savoir plus sur le coût des tâches avec ce paramètre dans notre article d'aide ; le coût peut être calculé sur la page Tarifs
- enable_content_parsing
 Type: boolean | null
 
 analyser le contenu des pages explorées
 champ facultatif
 définissez-le sur true pour utiliser le point de terminaison OnPage Content Parsing
 valeur par défaut : false
- enable_javascript
 Type: boolean | null
 
 charger le javascript sur une page
 champ facultatif
 définissez-le sur true si vous souhaitez charger les scripts disponibles sur une page
 valeur par défaut : false
 Remarque : si vous utilisez ce paramètre, des frais supplémentaires s'appliquent ; en savoir plus sur le coût des tâches avec ce paramètre dans notre article d'aide ; le coût peut être calculé sur la page Tarifs
- enable_www_redirect_check
 Type: boolean | null
 
 vérifier si le domaine a mis en place la redirection www
 champ facultatif
 définissez-le sur true si vous souhaitez vérifier si le domaine demandé a mis en place la redirection de www vers non-www ou de non-www vers www ;
 valeur par défaut : false
- enable_xhr
 Type: boolean | null
 
 activer XMLHttpRequest sur une page
 champ facultatif
 définissez-le sur true si vous souhaitez que notre robot d'exploration demande des données à un serveur web à l'aide de l'objet XMLHttpRequest
 valeur par défaut : false ;si vous utilisez ce champ, enable_javascript doit être défini sur true ;
- force_sitewide_checks
 Type: boolean | null
 
 activer les contrôles sur l'ensemble du site lors de l'exploration d'une seule page
 champ facultatif
 définissez-le sur true pour obtenir des données sur les contrôles sur l'ensemble du site lors de l'exploration d'une seule page ;
 valeur par défaut : false
- load_resources
 Type: boolean | null
 
 charger les ressources
 champ facultatif
 définissez-le sur true si vous souhaitez charger les images, feuilles de style, scripts et ressources cassées
 valeur par défaut : false
 Remarque : si vous utilisez ce paramètre, des frais supplémentaires s'appliquent ; en savoir plus sur le coût des tâches avec ce paramètre dans notre article d'aide ; le coût peut être calculé sur la page Tarifs
- max_crawl_depth
 Type: integer | null
 
 profondeur d'exploration
 champ facultatif
 la profondeur de liaison des pages à explorer ;
 par exemple, la page de départ de l'exploration est le niveau 0, les pages qui ont des liens depuis cette page sont le niveau 1, etc.
- max_crawl_pages
 Type: integer
 
 limite de pages explorées
 champ obligatoire
 le nombre de pages à explorer sur le domaine indiqué
 Remarque :
 si vous définissez max_crawl_pages sur 1 sans spécifier start_url ou sans y définir une page d'accueil, les contrôles sur l'ensemble du site suivants seront désactivés :
 test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect
 pour les activer malgré tout, définissez force_sitewide_checks sur truesi vous définissez max_crawl_pages sur 1 et spécifiez un start_url autre qu'une page d'accueil, tous les contrôles sur l'ensemble du site seront désactivés ;
 pour les activer malgré tout, définissez force_sitewide_checks sur true
- pingback_url
 Type: string | null
 
 URL de notification d'une tâche terminée
 champ facultatif
 lorsqu'une tâche est terminée, nous vous en informons par une requête GET envoyée à l'URL que vous avez spécifiée
 vous pouvez utiliser la chaîne ‘$id’ comme variable $id et ‘$tag’ comme variable $tag encodée pour URL. Nous définirons les valeurs nécessaires avant d'envoyer la requête.
 exemple :
 http://your-server.com/pingscript?id=$id
 http://your-server.com/pingscript?id=$id&tag=$tag
 Remarque : les caractères spéciaux de pingback_url seront encodés pour URL ;
 notamment, le caractère # sera encodé en %23
 
 en savoir plus dans notre centre d'aide
- priority_urls
 Type: array string[] | null
 
 urls à explorer en contournant la file d'attente
 champ facultatif
 les URL indiquées dans ce tableau seront explorées en premier, en contournant la file d'attente d'exploration ;
 Remarque : vous devez indiquer l'URL absolue ;
 vous pouvez indiquer jusqu'à 20 URL ;
 toutes les URL du tableau doivent appartenir au domaine target ;
 les sous-domaines seront ignorés, sauf si le paramètre allow_subdomains est défini sur trueexemple :
 "priority_urls": [ "https://dataforseo.com/apis/serp-api", "https://dataforseo.com/contact" ]
- respect_sitemap
 Type: boolean | null
 
 respecter le sitemap lors de l'exploration
 champ facultatif
 définissez-le sur true si vous souhaitez suivre l'ordre des pages indiquées dans le sitemap principal lors de l'exploration ;
 valeur par défaut : false
 Remarque : si ce paramètre est défini sur true, la valeur de click_depth dans la réponse de l'API sera égale à 0 ;
 le champ max_crawl_depth de la requête sera ignoré ; vous pouvez indiquer le nombre de pages à explorer à l'aide du paramètre max_crawl_pages
- return_despite_timeout
 Type: boolean | null
 
 renvoyer les données des pages malgré l'erreur d'expiration du délai
 champ facultatif
 si la valeur est true, les données seront fournies pour les pages qui n'ont pas pu être chargées dans les 120 secondes et qui ont répondu par une erreur d'expiration du délai ;
 valeur par défaut : false
- robots_txt_merge_mode
 Type: string | null
 
 fusionner avec les paramètres robots.txt ou les remplacer
 champ facultatif
 valeurs possibles : merge, override ;
 définissez-le sur override si vous souhaitez ignorer les restrictions d'exploration du site web et les autres paramètres robots.txt
 valeur par défaut : merge ;
 Remarque : si ce paramètre est défini sur override, indiquez le paramètre custom_robots_txt
- start_url
 Type: string | null
 
 la première url à explorer
 champ facultatif
 Remarque : vous devez indiquer une URL absolue
 si vous souhaitez explorer une seule page, indiquez son URL dans ce champ et définissez en plus le paramètre max_crawl_pages sur 1
 vous pouvez également utiliser le point de terminaison Instant Pages en direct pour obtenir des données spécifiques à la page
- store_raw_html
 Type: boolean | null
 
 stocker le HTML des pages explorées
 champ facultatif
 définissez-le sur true si vous souhaitez obtenir le HTML de la page à l'aide du point de terminaison OnPage Raw HTML
 valeur par défaut : false
- support_cookies
 Type: boolean | null
 
 prendre en charge les cookies sur les pages explorées
 champ facultatif
 définissez-le sur true pour prendre en charge les cookies lors de l'exploration des pages
 valeur par défaut : false
- switch_pool
 Type: boolean | null
 
 changer de pool de proxys
 champ facultatif
 si la valeur est true, des pools de proxys supplémentaires seront utilisés pour obtenir les données demandées ;
 ce paramètre peut être utilisé si un grand nombre de tâches est défini simultanément, ce qui entraîne des erreurs rate-limit et/ou site_unreachable occasionnelles
- tag
 Type: string | null
 
 identifiant de tâche défini par l'utilisateur
 champ facultatif
 la limite est de 255 caractères
 vous pouvez utiliser ce paramètre pour identifier la tâche et l'associer au résultat
 vous trouverez la valeur tag spécifiée dans l'objet data de la réponse
- target
 Type: string
 
 domaine cible
 champ obligatoire
 le nom de domaine doit être indiqué sans https:// ni www.
 si vous indiquez l'URL de la page, les résultats seront renvoyés pour le domaine contenu dans l'URL
- validate_micromarkup
 Type: boolean | null
 
 activer la validation des microdonnées
 champ facultatif
 définissez-le sur true si vous souhaitez utiliser le point de terminaison OnPage API Microdata
 valeur par défaut : false

Réponses

200
Type: object | null · Response36Afe1097B20_OnPageTaskPostResponseInfo
cost
Type: number | null Format: double

coût total des tâches, USD

status_code
Type: integer | null

code d'état général vous pouvez trouver la liste complète des codes de réponse ici

status_message
Type: string | null

message d'information général vous pouvez trouver la liste complète des messages d'information généraux ici

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

tableau de tâches

Type: object | null · Response36Afe1097B20_OnPageTaskPostTaskInfo
cost
Type: number | null Format: double

coût total des tâches, USD

data
Type: object | null

contient les mêmes paramètres que ceux spécifiés dans la requête POST

propertyName
Type: object | null
id
Type: string | null

identifiant de la tâche identifiant unique de la tâche dans notre système au format UUID

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

chemin de l'URL

result
Type: object | null

tableau de résultats
dans ce cas, la valeur sera null

result_count
Type: integer | null Format: int64

nombre d'éléments dans le tableau de résultats

status_code
Type: integer | null

code d'état de la tâche généré par DataForSEO ; peut être compris dans la plage suivante : 10000-60000 vous pouvez trouver la liste complète des codes de réponse ici

status_message
Type: string | null

message d'information de la tâche vous pouvez trouver la liste complète des messages d'information généraux ici

time
Type: string | null

temps d'exécution, en secondes

tasks_count
Type: integer | null Format: int64

le nombre de tâches dans le tableau de tâches

tasks_error
Type: integer | null Format: int64

le nombre de tâches dans le tableau de tâches renvoyées avec une erreur

time
Type: string | null

temps d'exécution total, en secondes

version
Type: string | null

la version actuelle de l'API
application/json
400

La requête n'a pas pu être traitée. Vérifiez les paramètres de la requête.
401

Une clé API Felo valide est requise.
402

La requête ne peut pas aboutir car une condition de facturation n'est pas remplie.
403

Le compte n'est pas autorisé à effectuer cette opération.
429

Une limite de requêtes ou de dépenses a été atteinte.
502

Le service n'a pas pu terminer la requête.
503

L'API ou le service de facturation est temporairement indisponible.
504

Le service a expiré lors du traitement de la requête.
default

Réponse d'erreur ; les réponses transmises depuis l'upstream peuvent utiliser les formats du fournisseur

application/json

post/v1/beta/dataforseo/on_page/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "max_crawl_pages": 10,
    "load_resources": true,
    "enable_javascript": true,
    "custom_js": "meta = {}; meta.url = document.URL; meta;",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

Afficher le 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": null
    }
  ]
}

Opération réussie

Configurer des tâches OnPage

AuthentificationRequired

DataForSEO

Configurer des tâches OnPage

Référence tarifaire