Method: pagespeedapi.runpagespeed

enum (Category)

A Lighthouse category to run; if none are given, only Performance category will be run

string

The locale used to localize formatted results

enum (Strategy)

The analysis strategy (desktop or mobile) to use, and desktop is the default

string

Required. The URL to fetch and analyze

string

Campaign name for analytics.

string

Campaign source for analytics.

string

The captcha token passed when filling out a captcha.

{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}

string

The url, pattern or origin which the metrics are on.

map (key: string, value: object (UserPageLoadMetricV5))

The map of <metrics, data>.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

string

The human readable speed "category" of the id.

string

The requested URL, which may differ from the resolved "id".

boolean

True if the result is an origin fallback from a page, false otherwise.

{
  "fetchTime": string,
  "requestedUrl": string,
  "finalUrl": string,
  "lighthouseVersion": string,
  "i18n": {
    object (I18n)
  },
  "userAgent": string,
  "audits": {
    string: {
      object (LighthouseAuditResultV5)
    },
    ...
  },
  "categoryGroups": {
    string: {
      object (CategoryGroupV5)
    },
    ...
  },
  "stackPacks": [
    {
      object (StackPack)
    }
  ],
  "environment": {
    object (Environment)
  },
  "runWarnings": array,
  "runtimeError": {
    object (RuntimeError)
  },
  "categories": {
    object (Categories)
  },
  "timing": {
    object (Timing)
  },
  "configSettings": {
    object (ConfigSettings)
  }
}

string

The time that this run was fetched.

string

The original requested url.

string

The final resolved url that was audited.

string

The lighthouse version that was used to generate this LHR.

object (I18n)

The internationalization strings that are required to render the LHR.

string

The user agent that was used to run this LHR.

map (key: string, value: object (LighthouseAuditResultV5))

Map of audits in the LHR.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map (key: string, value: object (CategoryGroupV5))

Map of category groups in the LHR.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (StackPack)

The Stack Pack advice strings.

object (Environment)

Environment settings that were used when making this LHR.

array (ListValue format)

List of all run warnings in the LHR. Will always output to at least [].

object (RuntimeError)

A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.

object (Categories)

Map of categories in the LHR.

object (Timing)

Timing information for this LHR.

object (ConfigSettings)

The configuration settings for this LHR.

{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}

object (RendererFormattedStrings)

Internationalized strings that are formatted to the locale in configSettings.

{
  "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
}

string

The disclaimer shown below a performance metric value.

string

The heading for the estimated page load savings opportunity of an audit.

string

The heading for the estimated page load savings of opportunity audits.

string

The error string shown next to an erroring audit.

string

The label shown next to an audit or metric that has had an error.

string

The label shown above a bulleted list of warnings.

string

The tooltip text on an expandable chevron icon.

string

The heading that is shown above a list of audits that are passing.

string

The heading shown above a list of audits that do not apply to a page.

string

The heading shown above a list of audits that were not computerd in the run.

string

The label shown preceding important warnings that may have invalidated an entire report.

string

The label that explains the score gauges scale (0-49, 50-89, 90-100).

string

The label for values shown in the summary of critical request chains.

string

The label for the initial request in a critical request chain.

string

The disclaimer shown under performance explaning that the network can vary.

string

The title of the lab data performance category.

{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}

string

The stack pack id.

string

The stack pack title.

string

The stack pack icon data uri.

map (key: string, value: string)

The stack pack advice strings.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}

string

The user agent string that was sent over the network.

string

The user agent string of the version of Chrome used.

number

The benchmark index number that indicates rough device class.

{
  "code": string,
  "message": string
}

string

The enumerated Lighthouse Error code.

string

A human readable message explaining the error code.

{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}

object (LighthouseCategoryV5)

The accessibility category, containing all accessibility related audits.

object (LighthouseCategoryV5)

The best practices category, containing all best practices related audits.

object (LighthouseCategoryV5)

The Search-Engine-Optimization (SEO) category, containing all seo related audits.

object (LighthouseCategoryV5)

The Progressive-Web-App (PWA) category, containing all pwa related audits.

object (LighthouseCategoryV5)

The performance category, containing all performance related audits.

{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}

string

The string identifier of the category.

string

The human-friendly name of the category.

string

A more detailed description of the category and its importance.

string

A description for the manual audits in the category.

object (AuditRefs)

An array of references to all the audit members of this category.

value (Value format)

The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

{
  "id": string,
  "weight": number,
  "group": string
}

string

The audit ref id.

number

The weight this audit's score has on the overall category score.

string

The category group that the audit belongs to (optional).

{
  "total": number
}

number

The total duration of Lighthouse's run.

{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}

value (Value format)

List of categories of audits the run should conduct.

string

The form factor the emulation should use. This field is deprecated, formFactor should be used instead.

string

The locale setting.

string

How Lighthouse was run, e.g. from the Chrome extension or from the npm module.

string

How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.

{
  "major": string,
  "minor": string
}

string

The major version number of PageSpeed used to generate these results.

string

The minor version number of PageSpeed used to generate these results.