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