Pagespeedapi: runpagespeed

Executa a análise do PageSpeed na página do URL especificado e retorna pontuações do PageSpeed, uma lista de sugestões para acelerar a página e 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 para executar. Se nenhuma for fornecida, apenas a categoria "Performance" será executada. Os valores aceitáveis são: "accessibility" "best-practices" "performance" "seo"
locale	string	O local usado para localizar resultados formatados
strategy	string	A estratégia de análise (computador ou dispositivo móvel) a ser usada. O padrão é computador. Os valores aceitáveis são: "desktop": busca e análise do URL para navegadores de computador "mobile": buscar e analisar o URL para dispositivos móveis
utm_campaign	string	Nome da campanha para o Google Analytics.
utm_source	string	Origem da campanha para o Google Analytics.

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 do CAPTCHA. Os valores aceitáveis são: "CAPTCHA_BLOCKING" "CAPTCHA_MATCHED" "CAPTCHA_NEEDED" "CAPTCHA_NOT_NEEDED" "CAPTCHA_UNMATCHED"
kind	string	Tipo de resultado.
id	string	URL canônico e final do documento, após seguir os redirecionamentos de página (se houver).
loadingExperience	nested object	Métricas da experiência de carregamento de página dos usuários finais.
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 da 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 usada 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 da 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 UTC desta 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 Lighthouse usada para gerar este LHR.
lighthouseResult.userAgent	string	O user agent usado para executar este LHR.
lighthouseResult.fetchTime	string	O horário em que esta execução foi buscada.
lighthouseResult.environment	object	Configurações de ambiente usadas ao criar este 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 vai gerar pelo menos `[]`.
lighthouseResult.configSettings	object	As configurações de configuração para este LHR.
lighthouseResult.configSettings.emulatedFormFactor	string	O formato que a emulação deve usar. Os valores aceitáveis são: "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.
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 de pontuação enumerado. 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 mostrado na interface para essa auditoria.
lighthouseResult.audits.(key).explanation	string	Uma explicação dos erros na auditoria.
lighthouseResult.audits.(key).errorMessage	string	Uma mensagem de erro 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 da importância dela.
lighthouseResult.categories.(key).score	nested object
lighthouseResult.categories.(key).manualDescription	string	Uma descrição para as auditorias manuais na categoria.
lighthouseResult.categories.(key).auditRefs[]	list	Uma matriz de referências a todos os membros de auditoria dessa categoria.
lighthouseResult.categories.(key).auditRefs[].id	string	O ID de referência da auditoria.
lighthouseResult.categories.(key).auditRefs[].weight	double	O peso que a pontuação desta auditoria tem na pontuação geral da categoria.
lighthouseResult.categories.(key).auditRefs[].group	string	O grupo de categorias a que a auditoria pertence (opcional).
lighthouseResult.categoryGroups	object	Mapa de 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 e a mensagem de erros de tempo 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.