Pagespeedapi: runpagespeed

Executa uma análise do PageSpeed na página no URL especificado e retorna as pontuações do PageSpeed, uma lista de sugestões para tornar a página mais rápida, além de outras informações. Faça o teste agora.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/pagespeedonline/v5/runPagespeed

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de consulta obrigatórios
url string O URL a ser buscado e analisado
Parâmetros de consulta opcionais
category string Uma categoria do Lighthouse a ser executada. Se nenhuma for fornecida, somente a categoria "Desempenho" será executada

Os valores aceitáveis são os seguintes:
  • "accessibility"
  • "best-practices"
  • "performance"
  • "pwa"
  • "seo"
locale string Localidade usada para localizar resultados formatados
strategy string A estratégia de análise (computador ou dispositivo móvel) a ser usada (computador é o padrão)

Os valores aceitáveis são os seguintes:
  • "desktop": buscar e analisar o URL de navegadores para computador
  • "mobile": busque e analise o URL em dispositivos móveis
utm_campaign string Nome da campanha para análise.
utm_source string Origem da campanha para análise.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "varianceDisclaimer": string,
        "opportunityResourceColumnLabel": string,
        "opportunitySavingsColumnLabel": string,
        "errorMissingAuditInfo": string,
        "errorLabel": string,
        "warningHeader": string,
        "auditGroupExpandTooltip": string,
        "passedAuditsGroupTitle": string,
        "notApplicableAuditsGroupTitle": string,
        "manualAuditsGroupTitle": string,
        "toplevelWarningsMessage": string,
        "scorescaleLabel": string,
        "crcLongestDurationLabel": string,
        "crcInitialNavigation": string,
        "lsPerformanceCategoryDescription": string,
        "labDataTitle": string
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}
Nome da propriedade Valor Descrição Observações
captchaResult string O resultado da verificação de captcha

Os valores aceitáveis são os seguintes:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string Tipo de resultado.
id string URL canonizado e final do documento, depois de seguir os redirecionamentos da página (se houver).
loadingExperience nested object Métricas dos usuários finais experiência de carregamento da página.
loadingExperience.id string O URL, o padrão ou a origem em que as métricas estão.
loadingExperience.metrics object
loadingExperience.metrics.(key) object O tipo de métrica.
loadingExperience.metrics.(key).distributions[] list
loadingExperience.metrics.(key).distributions[].min integer
loadingExperience.metrics.(key).distributions[].max integer
loadingExperience.metrics.(key).distributions[].proportion double
version object A versão do PageSpeed usada para gerar esses resultados.
version.major integer O número da versão principal do PageSpeed usado para gerar esses resultados.
version.minor integer O número da versão secundária do PageSpeed usado para gerar esses resultados.
loadingExperience.metrics.(key).category string

Os valores aceitáveis são:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.overall_category string

Os valores aceitáveis são:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object Métricas da experiência agregada de carregamento de página da origem
originLoadingExperience.id string O URL, o padrão ou a origem em que as métricas estão.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object O tipo de métrica.
originLoadingExperience.metrics.(key).percentile integer
originLoadingExperience.metrics.(key).distributions[] list
originLoadingExperience.metrics.(key).distributions[].min integer
originLoadingExperience.metrics.(key).distributions[].max integer
originLoadingExperience.metrics.(key).distributions[].proportion double
originLoadingExperience.metrics.(key).category string

Os valores aceitáveis são:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

Os valores aceitáveis são:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.initial_url string
analysisUTCTimestamp string O carimbo de data/hora em UTC da análise.
lighthouseResult nested object Resposta do Lighthouse para o URL de auditoria como um objeto.
lighthouseResult.requestedUrl string O URL original solicitado.
lighthouseResult.finalUrl string O URL final resolvido que foi auditado.
lighthouseResult.lighthouseVersion string A versão do farol que foi usada para gerar esse LHR.
lighthouseResult.userAgent string O user agent usado para executar este LHR.
lighthouseResult.fetchTime string O horário em que essa execução foi buscada.
lighthouseResult.environment object Configurações de ambiente usadas para criar esse LHR.
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list Lista de todos os avisos de execução no LHR. Sempre produzirá pelo menos `[]`.
lighthouseResult.configSettings object As definições de configuração para este LHR.
lighthouseResult.configSettings.emulatedFormFactor string O formato que a emulação precisa usar

Os valores aceitáveis são os seguintes:
  • "UNKNOWN_FORM_FACTOR"
  • "desktop"
  • "mobile"
  • "none"
lighthouseResult.configSettings.locale string A configuração de localidade
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object Mapa de auditorias no LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string O ID da auditoria.
lighthouseResult.audits.(key).title string O título legível por humanos.
lighthouseResult.audits.(key).description string A descrição da auditoria.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string O modo de exibição da pontuação enumerada.

Os valores aceitáveis são:
  • "SCORE_DISPLAY_MODE_UNSPECIFIED"
  • "binary"
  • "error"
  • "informative"
  • "manual"
  • "not_applicable"
  • "numeric"
lighthouseResult.audits.(key).displayValue string O valor que deve ser exibido na IU para esta auditoria.
lighthouseResult.audits.(key).explanation string Uma explicação dos erros na auditoria.
lighthouseResult.audits.(key).errorMessage string Uma mensagem de um erro gerado na auditoria.
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object Seção de detalhes de formato livre da auditoria.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object Mapa de categorias no LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string O identificador de string da categoria.
lighthouseResult.categories.(key).title string O nome legível da categoria
lighthouseResult.categories.(key).description string Uma descrição mais detalhada da categoria e sua importância.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string Uma descrição das auditorias manuais na categoria.
lighthouseResult.categories.(key).auditRefs[] list Uma matriz de referências a todos os membros da auditoria dessa categoria.
lighthouseResult.categories.(key).auditRefs[].id string O ID de referência de auditoria.
lighthouseResult.categories.(key).auditRefs[].weight double O peso da pontuação da auditoria na pontuação geral da categoria.
lighthouseResult.categories.(key).auditRefs[].group string O grupo de categoria ao qual a auditoria pertence (opcional).
lighthouseResult.categoryGroups object Mapa dos grupos de categorias no LHR.
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object Objeto que contém o código + a mensagem de quaisquer erros de ambiente de execução gerados.
lighthouseResult.runtimeError.code string

Os valores aceitáveis são:
  • "ERRORED_DOCUMENT_REQUEST"
  • "FAILED_DOCUMENT_REQUEST"
  • "INSECURE_DOCUMENT_REQUEST"
  • "INVALID_SPEEDLINE"
  • "NO_DCL"
  • "NO_DOCUMENT_REQUEST"
  • "NO_ERROR"
  • "NO_FCP"
  • "NO_NAVSTART"
  • "NO_SCREENSHOTS"
  • "NO_SPEEDLINE_FRAMES"
  • "NO_TRACING_STARTED"
  • "PARSING_PROBLEM"
  • "PROTOCOL_TIMEOUT"
  • "READ_FAILED"
  • "SPEEDINDEX_OF_ZERO"
  • "TRACING_ALREADY_STARTED"
  • "UNKNOWN_ERROR"
lighthouseResult.runtimeError.message string
lighthouseResult.timing object Informações de tempo para este LHR.
lighthouseResult.timing.total double A duração total da execução do Lighthouse
lighthouseResult.i18n object As strings de internacionalização necessárias para renderizar o LHR.
lighthouseResult.i18n.rendererFormattedStrings object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle string

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.