Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="pagespeedonline_v5.html">PageSpeed Insights API</a> . <a href="pagespeedonline_v5.pagespeedapi.html">pagespeedapi</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 81 | <code><a href="#runpagespeed">runpagespeed(url=None, category=None, utm_campaign=None, captchaToken=None, locale=None, strategy=None, utm_source=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.</p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <code class="details" id="close">close()</code> |
| 86 | <pre>Close httplib2 connections.</pre> |
| 87 | </div> |
| 88 | |
| 89 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 90 | <code class="details" id="runpagespeed">runpagespeed(url=None, category=None, utm_campaign=None, captchaToken=None, locale=None, strategy=None, utm_source=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <pre>Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | |
| 93 | Args: |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 94 | url: string, Required. The URL to fetch and analyze |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 95 | category: string, A Lighthouse category to run; if none are given, only Performance category will be run (repeated) |
| 96 | Allowed values |
| 97 | CATEGORY_UNSPECIFIED - Default UNDEFINED category. |
| 98 | ACCESSIBILITY - Accessibility (a11y), category pertaining to a website's capacity to be accessible to all users. |
| 99 | BEST_PRACTICES - Best Practices, category pertaining to a website's conformance to web best practice. |
| 100 | PERFORMANCE - Performance, category pertaining to a website's performance. |
| 101 | PWA - Progressive Web App (PWA), category pertaining to a website's ability to be run as a PWA. |
| 102 | SEO - Search Engine Optimization (SEO), category pertaining to a website's ability to be indexed by search engines. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 103 | utm_campaign: string, Campaign name for analytics. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 104 | captchaToken: string, The captcha token passed when filling out a captcha. |
| 105 | locale: string, The locale used to localize formatted results |
| 106 | strategy: string, The analysis strategy (desktop or mobile) to use, and desktop is the default |
| 107 | Allowed values |
| 108 | STRATEGY_UNSPECIFIED - UNDEFINED. |
| 109 | DESKTOP - Fetch and analyze the URL for desktop browsers. |
| 110 | MOBILE - Fetch and analyze the URL for mobile devices. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 111 | utm_source: string, Campaign source for analytics. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | x__xgafv: string, V1 error format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | Allowed values |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 114 | 1 - v1 error format |
| 115 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | |
| 117 | Returns: |
| 118 | An object of the form: |
| 119 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | { # The Pagespeed API response object. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 121 | "version": { # The Pagespeed Version object. # The version of PageSpeed used to generate these results. |
| 122 | "major": "A String", # The major version number of PageSpeed used to generate these results. |
| 123 | "minor": "A String", # The minor version number of PageSpeed used to generate these results. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 124 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 125 | "captchaResult": "A String", # The captcha verify result |
| 126 | "analysisUTCTimestamp": "A String", # The UTC timestamp of this analysis. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 127 | "kind": "A String", # Kind of result. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 128 | "loadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of end users' page loading experience. |
| 129 | "origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise. |
| 130 | "overall_category": "A String", # The human readable speed "category" of the id. |
| 131 | "initial_url": "A String", # The requested URL, which may differ from the resolved "id". |
| 132 | "metrics": { # The map of . |
| 133 | "a_key": { # A CrUX metric object for a single metric and form factor. |
| 134 | "percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90. |
| 135 | "median": 42, # The median number of the metric, in millisecond. |
| 136 | "category": "A String", # The category of the specific time metric. |
| 137 | "formFactor": "A String", # Identifies the form factor of the metric being collected. |
| 138 | "metricId": "A String", # Identifies the type of the metric. |
| 139 | "distributions": [ # Metric distributions. Proportions should sum up to 1. |
| 140 | { # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond. |
| 141 | "proportion": 3.14, # The proportion of data in this bucket. |
| 142 | "max": 42, # Upper bound for a bucket's range. |
| 143 | "min": 42, # Lower bound for a bucket's range. |
| 144 | }, |
| 145 | ], |
| 146 | }, |
| 147 | }, |
| 148 | "id": "A String", # The url, pattern or origin which the metrics are on. |
| 149 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 150 | "lighthouseResult": { # The Lighthouse result object. # Lighthouse response for the audit url as an object. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 151 | "categories": { # The categories in a Lighthouse run. # Map of categories in the LHR. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 152 | "seo": { # A Lighthouse category. # The Search-Engine-Optimization (SEO) category, containing all seo related audits. |
| 153 | "id": "A String", # The string identifier of the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 154 | "auditRefs": [ # An array of references to all the audit members of this category. |
| 155 | { # A light reference to an audit by id, used to group and weight audits in a given category. |
| 156 | "id": "A String", # The audit ref id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 157 | "weight": 3.14, # The weight this audit's score has on the overall category score. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 158 | "group": "A String", # The category group that the audit belongs to (optional). |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 159 | }, |
| 160 | ], |
| 161 | "manualDescription": "A String", # A description for the manual audits in the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 162 | "description": "A String", # A more detailed description of the category and its importance. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 163 | "title": "A String", # The human-friendly name of the category. |
| 164 | "score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 165 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 166 | "accessibility": { # A Lighthouse category. # The accessibility category, containing all accessibility related audits. |
| 167 | "id": "A String", # The string identifier of the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 168 | "auditRefs": [ # An array of references to all the audit members of this category. |
| 169 | { # A light reference to an audit by id, used to group and weight audits in a given category. |
| 170 | "id": "A String", # The audit ref id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 171 | "weight": 3.14, # The weight this audit's score has on the overall category score. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 172 | "group": "A String", # The category group that the audit belongs to (optional). |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 173 | }, |
| 174 | ], |
| 175 | "manualDescription": "A String", # A description for the manual audits in the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 176 | "description": "A String", # A more detailed description of the category and its importance. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 177 | "title": "A String", # The human-friendly name of the category. |
| 178 | "score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 179 | }, |
| 180 | "performance": { # A Lighthouse category. # The performance category, containing all performance related audits. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 181 | "id": "A String", # The string identifier of the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 182 | "auditRefs": [ # An array of references to all the audit members of this category. |
| 183 | { # A light reference to an audit by id, used to group and weight audits in a given category. |
| 184 | "id": "A String", # The audit ref id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 185 | "weight": 3.14, # The weight this audit's score has on the overall category score. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 186 | "group": "A String", # The category group that the audit belongs to (optional). |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 187 | }, |
| 188 | ], |
| 189 | "manualDescription": "A String", # A description for the manual audits in the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 190 | "description": "A String", # A more detailed description of the category and its importance. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 191 | "title": "A String", # The human-friendly name of the category. |
| 192 | "score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 193 | }, |
| 194 | "best-practices": { # A Lighthouse category. # The best practices category, containing all best practices related audits. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 195 | "id": "A String", # The string identifier of the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 196 | "auditRefs": [ # An array of references to all the audit members of this category. |
| 197 | { # A light reference to an audit by id, used to group and weight audits in a given category. |
| 198 | "id": "A String", # The audit ref id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 199 | "weight": 3.14, # The weight this audit's score has on the overall category score. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 200 | "group": "A String", # The category group that the audit belongs to (optional). |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 201 | }, |
| 202 | ], |
| 203 | "manualDescription": "A String", # A description for the manual audits in the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 204 | "description": "A String", # A more detailed description of the category and its importance. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 205 | "title": "A String", # The human-friendly name of the category. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 206 | "score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) |
| 207 | }, |
| 208 | "pwa": { # A Lighthouse category. # The Progressive-Web-App (PWA) category, containing all pwa related audits. |
| 209 | "id": "A String", # The string identifier of the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 210 | "auditRefs": [ # An array of references to all the audit members of this category. |
| 211 | { # A light reference to an audit by id, used to group and weight audits in a given category. |
| 212 | "id": "A String", # The audit ref id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 213 | "weight": 3.14, # The weight this audit's score has on the overall category score. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 214 | "group": "A String", # The category group that the audit belongs to (optional). |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 215 | }, |
| 216 | ], |
| 217 | "manualDescription": "A String", # A description for the manual audits in the category. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 218 | "description": "A String", # A more detailed description of the category and its importance. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 219 | "title": "A String", # The human-friendly name of the category. |
| 220 | "score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 221 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 222 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 223 | "categoryGroups": { # Map of category groups in the LHR. |
| 224 | "a_key": { # Message containing a category |
| 225 | "title": "A String", # The human readable title of the group |
| 226 | "description": "A String", # The description of what the category is grouping |
| 227 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 228 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 229 | "requestedUrl": "A String", # The original requested url. |
| 230 | "lighthouseVersion": "A String", # The lighthouse version that was used to generate this LHR. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 231 | "stackPacks": [ # The Stack Pack advice strings. |
| 232 | { # Message containing Stack Pack information. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 233 | "id": "A String", # The stack pack id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 234 | "title": "A String", # The stack pack title. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 235 | "descriptions": { # The stack pack advice strings. |
| 236 | "a_key": "A String", |
| 237 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 238 | "iconDataURL": "A String", # The stack pack icon data uri. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 239 | }, |
| 240 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 241 | "environment": { # Message containing environment configuration for a Lighthouse run. # Environment settings that were used when making this LHR. |
| 242 | "hostUserAgent": "A String", # The user agent string of the version of Chrome used. |
| 243 | "networkUserAgent": "A String", # The user agent string that was sent over the network. |
| 244 | "benchmarkIndex": 3.14, # The benchmark index number that indicates rough device class. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 245 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 246 | "fetchTime": "A String", # The time that this run was fetched. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 247 | "userAgent": "A String", # The user agent that was used to run this LHR. |
| 248 | "runWarnings": [ # List of all run warnings in the LHR. Will always output to at least `[]`. |
| 249 | "", |
| 250 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 251 | "finalUrl": "A String", # The final resolved url that was audited. |
| 252 | "runtimeError": { # Message containing a runtime error config. # A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded. |
| 253 | "code": "A String", # The enumerated Lighthouse Error code. |
| 254 | "message": "A String", # A human readable message explaining the error code. |
| 255 | }, |
| 256 | "configSettings": { # Message containing the configuration settings for the Lighthouse run. # The configuration settings for this LHR. |
| 257 | "emulatedFormFactor": "A String", # The form factor the emulation should use. |
| 258 | "locale": "A String", # The locale setting. |
| 259 | "onlyCategories": "", # List of categories of audits the run should conduct. |
| 260 | "channel": "A String", # How Lighthouse was run, e.g. from the Chrome extension or from the npm module. |
| 261 | }, |
| 262 | "timing": { # Message containing the performance timing data for the Lighthouse run. # Timing information for this LHR. |
| 263 | "total": 3.14, # The total duration of Lighthouse's run. |
| 264 | }, |
| 265 | "i18n": { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR. |
| 266 | "rendererFormattedStrings": { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings. |
| 267 | "labDataTitle": "A String", # The title of the lab data performance category. |
| 268 | "auditGroupExpandTooltip": "A String", # The tooltip text on an expandable chevron icon. |
| 269 | "scorescaleLabel": "A String", # The label that explains the score gauges scale (0-49, 50-89, 90-100). |
| 270 | "opportunityResourceColumnLabel": "A String", # The heading for the estimated page load savings opportunity of an audit. |
| 271 | "varianceDisclaimer": "A String", # The disclaimer shown below a performance metric value. |
| 272 | "opportunitySavingsColumnLabel": "A String", # The heading for the estimated page load savings of opportunity audits. |
| 273 | "warningHeader": "A String", # The label shown above a bulleted list of warnings. |
| 274 | "lsPerformanceCategoryDescription": "A String", # The disclaimer shown under performance explaning that the network can vary. |
| 275 | "notApplicableAuditsGroupTitle": "A String", # The heading shown above a list of audits that do not apply to a page. |
| 276 | "toplevelWarningsMessage": "A String", # The label shown preceding important warnings that may have invalidated an entire report. |
| 277 | "crcInitialNavigation": "A String", # The label for the initial request in a critical request chain. |
| 278 | "errorMissingAuditInfo": "A String", # The error string shown next to an erroring audit. |
| 279 | "errorLabel": "A String", # The label shown next to an audit or metric that has had an error. |
| 280 | "passedAuditsGroupTitle": "A String", # The heading that is shown above a list of audits that are passing. |
| 281 | "crcLongestDurationLabel": "A String", # The label for values shown in the summary of critical request chains. |
| 282 | "manualAuditsGroupTitle": "A String", # The heading shown above a list of audits that were not computerd in the run. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 283 | }, |
| 284 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 285 | "audits": { # Map of audits in the LHR. |
| 286 | "a_key": { # An audit's result object in a Lighthouse result. |
| 287 | "description": "A String", # The description of the audit. |
| 288 | "numericValue": 3.14, # A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present. |
| 289 | "title": "A String", # The human readable title. |
| 290 | "displayValue": "A String", # The value that should be displayed on the UI for this audit. |
| 291 | "score": "", # The score of the audit, can be null. |
| 292 | "id": "A String", # The audit's id. |
| 293 | "details": { # Freeform details section of the audit. |
| 294 | "a_key": "", # Properties of the object. |
| 295 | }, |
| 296 | "errorMessage": "A String", # An error message from a thrown error inside the audit. |
| 297 | "scoreDisplayMode": "A String", # The enumerated score display mode. |
| 298 | "warnings": "", # Possible warnings that occurred in the audit, can be null. |
| 299 | "explanation": "A String", # An explanation of the errors in the audit. |
| 300 | }, |
| 301 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 302 | }, |
| 303 | "originLoadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of the aggregated page loading experience of the origin |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 304 | "origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 305 | "overall_category": "A String", # The human readable speed "category" of the id. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 306 | "initial_url": "A String", # The requested URL, which may differ from the resolved "id". |
| 307 | "metrics": { # The map of . |
| 308 | "a_key": { # A CrUX metric object for a single metric and form factor. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 309 | "percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90. |
| 310 | "median": 42, # The median number of the metric, in millisecond. |
| 311 | "category": "A String", # The category of the specific time metric. |
| 312 | "formFactor": "A String", # Identifies the form factor of the metric being collected. |
| 313 | "metricId": "A String", # Identifies the type of the metric. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 314 | "distributions": [ # Metric distributions. Proportions should sum up to 1. |
| 315 | { # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 316 | "proportion": 3.14, # The proportion of data in this bucket. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 317 | "max": 42, # Upper bound for a bucket's range. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 318 | "min": 42, # Lower bound for a bucket's range. |
| 319 | }, |
| 320 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 321 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 322 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 323 | "id": "A String", # The url, pattern or origin which the metrics are on. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 324 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 325 | "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 326 | }</pre> |
| 327 | </div> |
| 328 | |
| 329 | </body></html> |