Felo API PlatformFelo API Platform
Tous les endpoints DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Configurer des tâches Lighthouse

Serveur:https://openapi.felo.ai
Bibliothèques clientes

DataForSEO

​

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

Configurer des tâches Lighthouse

​

Met un audit Lighthouse en file d'attente au lieu d'attendre son résultat, et renvoie un id de tâche. À utiliser quand l'audit dépasserait la patience d'un appel d'outil ; récupérez-le avec get_dataforseo_on_page_lighthouse_task_get_json et voyez ce qui est prêt avec get_dataforseo_on_page_lighthouse_ready. 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. ⚠️ Le même rapport de 245 KB à l'arrivée : le coût de contexte est différé, pas évité — restreignez-le avec categories ou audits ici, pas plus tard.

Référence tarifaire

  • Mesure : coût de réponse déclaré.
  • Estimation de référence par requête : USD 0.0051.
  • 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)[]
    • audits
      Type: array string[] | null

      audits Lighthouse
      champ facultatif
      les audits sont des tests individuels que Lighthouse exécute pour chaque fonctionnalité/optimisation/métrique spécifique afin de produire un score numérique (voir la définition officielle)si vous ignorez ce champ, nous renverrons les données de tous les audits
      utilisez ce champ pour obtenir les données des audits spécifiques que vous indiquez ici

      remarque : certains audits n'appartiennent pas à une catégorie spécifique et sont des mesures autonomes de la qualité de la page

      en général, il peut y avoir plusieurs cas d'usage :

      1. si vous ignorez categories, vous pouvez utiliser ce champ pour obtenir uniquement les données des audits indiqués
      par exemple, si vous ignorez "categories" et indiquez "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], vous obtiendrez uniquement les données de ces audits

      2. si vous indiquez une catégorie, vous pouvez utiliser ce champ pour recevoir en plus les audits qui n'appartiennent pas à la ou aux catégories que vous avez indiquées
      par exemple, si vous indiquez "categories": ["seo"] et "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], vous obtiendrez uniquement ces audits sous « performance » et tous les audits sous « seo »

      vous pouvez obtenir la liste complète des audits possibles ici

    • browser_cpu_throttling_multiplier
      Type: number | null

      multiplicateur de limitation du CPU du navigateur
      obligatoire si browser_network_throttling_method est défini sur devtools ;
      définissez le multiplicateur de limitation du CPU pour simuler les conditions de performance de l'appareil pendant l'audit Lighthouse ;
      peut être spécifié dans la plage suivante : 1–4 ;
      Remarque : ce paramètre n'est appliqué que lorsque browser_network_throttling_method est défini sur devtools ;

    • browser_network_throttling
      Type: string | null

      limitation réseau du navigateur
      obligatoire si browser_network_throttling_method est défini sur devtools ;
      définissez le profil de limitation réseau pour simuler les conditions de débit de connexion pendant l'audit Lighthouse ;
      valeurs possibles : no_throttling, fast_4g, slow_4g, regular_3g, pc ;
      Remarque : ce paramètre n'est appliqué que lorsque browser_network_throttling_method est défini sur devtools ;

    • browser_network_throttling_method
      Type: string | null

      méthode de limitation réseau du navigateur
      champ facultatif
      définit la méthode utilisée pour appliquer la limitation pendant l'audit Lighthouse ;
      valeurs possibles :
      simulate - calcule des métriques de performance estimées sans appliquer de limitation explicite ;
      devtools - applique les paramètres de limitation spécifiés dans browser_network_throttling et browser_cpu_throttling_multiplier ;
      provided - utilise les conditions réseau de l'environnement d'exploration ;

    • browser_screen_height
      Type: integer | null

      hauteur d'écran du navigateur
      champ facultatif
      définissez la hauteur d'écran du navigateur utilisé pour l'audit Lighthouse afin d'émuler un appareil particulier ;
      peut être spécifiée dans la plage suivante : 240–9999 ;

    • browser_screen_scale_factor
      Type: number | null

      facteur d'échelle d'écran du navigateur
      champ facultatif
      définissez le ratio de pixels de l'appareil du navigateur utilisé pour l'audit Lighthouse ;
      peut être spécifié dans la plage suivante : 0.5–3 ;

    • browser_screen_width
      Type: integer | null Format: int64

      largeur d'écran du navigateur
      champ facultatif
      définissez la largeur d'écran du navigateur utilisé pour l'audit Lighthouse afin d'émuler un appareil particulier ;
      peut être spécifiée dans la plage suivante : 240–9999 ;

    • categories
      Type: array string[] | null

      catégories d'audits Lighthouse
      champ facultatif
      chaque catégorie est un ensemble d'audits et de groupes d'audits qui applique une pondération et une notation à la section (voir la définition officielle)si vous ignorez ce champ, nous renverrons les données de toutes les catégories, sauf si vous indiquez audits
      utilisez ce champ pour obtenir les données des catégories spécifiques que vous indiquez ici

      valeurs possibles :
      seo, performance, best_practices, accessibility

    • custom_user_agent
      Type: string | null

      user agent personnalisé
      champ facultatif
      indiquez le user agent personnalisé utilisé par le navigateur lors de l'exécution de l'audit Lighthouse ;
      peut être indiqué avec un maximum de 254 caractères ;

    • for_mobile
      Type: boolean | null

      applique l'émulation mobile
      champ facultatif
      si la valeur est true, Lighthouse utilisera l'émulation d'appareil et d'écran mobiles pour tester la page dans un environnement mobile
      si la valeur est false, les résultats seront fournis pour ordinateur de bureau
      valeur par défaut : false

    • language_code
      Type: string | null

      code de langue Lighthouse
      champ facultatif
      vous pouvez recevoir la liste des langues disponibles du moteur de recherche avec leur language_code en effectuant une requête distincte vers https://api.dataforseo.com/v3/on_page/lighthouse/languages
      valeur par défaut :
      en

    • language_name
      Type: string | null

      nom de langue Lighthouse
      champ facultatif
      vous pouvez recevoir la liste des langues disponibles du moteur de recherche avec leur language_name en effectuant une requête distincte vers https://api.dataforseo.com/v3/on_page/lighthouse/languages
      valeur par défaut :
      English

    • 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 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 ;
      à savoir, le caractère # sera encodé en %23 en savoir plus dans notre centre d'aide

    • 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

    • url
      Type: string

      URL cible
      champ obligatoire
      la page cible doit être indiquée avec son URL absolue (y compris http:// ou https://)
      exemple :
      https://dataforseo.com/

    • version
      Type: string | null

      version de Lighthouse
      champ facultatif
      vous pouvez obtenir les résultats propres à une version donnée de Lighthouse en indiquant son numéro
      vous trouverez la liste des versions disponibles via le point de terminaison Lighthouse Versions

Réponses
  • 200
    Type: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo
    • 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_OnPageLighthouseTaskPostTaskInfo
        • 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: array (object | null)[] | null
          • propertyName
            Type: object | 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
Request Example for post/v1/beta/dataforseo/on_page/lighthouse/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'
{
  "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
      ]
    }
  ]
}
Setting Lighthouse Tasks