1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
{
"kind": "discovery#restDescription",
"etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/qhwLKT1ivQY6l5z8bbFPi2uFkhA\"",
"discoveryVersion": "v1",
"id": "pagespeedonline:v1",
"name": "pagespeedonline",
"version": "v1",
"revision": "20161101",
"title": "PageSpeed Insights API",
"description": "Analyzes the performance of a web page and provides tailored suggestions to make that page faster.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/pagespeed-16.png",
"x32": "https://www.google.com/images/icons/product/pagespeed-32.png"
},
"documentationLink": "https://developers.google.com/speed/docs/insights/v1/getting_started",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/pagespeedonline/v1/",
"basePath": "/pagespeedonline/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "pagespeedonline/v1/",
"batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"location": "query"
}
},
"schemas": {
"Result": {
"id": "Result",
"type": "object",
"properties": {
"formattedResults": {
"type": "object",
"description": "Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.",
"properties": {
"locale": {
"type": "string",
"description": "The locale of the formattedResults, e.g. \"en_US\"."
},
"ruleResults": {
"type": "object",
"description": "Dictionary of formatted rule results, with one entry for each PageSpeed rule instantiated and run by the server.",
"additionalProperties": {
"type": "object",
"description": "The enum-like identifier for this rule. For instance \"EnableKeepAlive\" or \"AvoidCssImport\". Not localized.",
"properties": {
"localizedRuleName": {
"type": "string",
"description": "Localized name of the rule, intended for presentation to a user."
},
"ruleImpact": {
"type": "number",
"description": "The impact (unbounded floating point value) that implementing the suggestions for this rule would have on making the page faster. Impact is comparable between rules to determine which rule's suggestions would have a higher or lower impact on making a page faster. For instance, if enabling compression would save 1MB, while optimizing images would save 500kB, the enable compression rule would have 2x the impact of the image optimization rule, all other things being equal.",
"format": "double"
},
"urlBlocks": {
"type": "array",
"description": "List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details.",
"items": {
"type": "object",
"properties": {
"header": {
"type": "object",
"description": "Heading to be displayed with the list of URLs.",
"properties": {
"args": {
"type": "array",
"description": "List of arguments for the format string.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION."
},
"value": {
"type": "string",
"description": "Argument value, as a localized string."
}
}
}
},
"format": {
"type": "string",
"description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the following $1 resources would save a total of $2 bytes'."
}
}
},
"urls": {
"type": "array",
"description": "List of entries that provide information about URLs in the url block. Optional.",
"items": {
"type": "object",
"properties": {
"details": {
"type": "array",
"description": "List of entries that provide additional details about a single URL. Optional.",
"items": {
"type": "object",
"properties": {
"args": {
"type": "array",
"description": "List of arguments for the format string.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION."
},
"value": {
"type": "string",
"description": "Argument value, as a localized string."
}
}
}
},
"format": {
"type": "string",
"description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Unnecessary metadata for this resource adds an additional $1 bytes to its download size'."
}
}
}
},
"result": {
"type": "object",
"description": "A format string that gives information about the URL, and a list of arguments for that format string.",
"properties": {
"args": {
"type": "array",
"description": "List of arguments for the format string.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION."
},
"value": {
"type": "string",
"description": "Argument value, as a localized string."
}
}
}
},
"format": {
"type": "string",
"description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the resource at URL $1 can save $2 bytes'."
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"id": {
"type": "string",
"description": "Canonicalized and final URL for the document, after following page redirects (if any)."
},
"invalidRules": {
"type": "array",
"description": "List of rules that were specified in the request, but which the server did not know how to instantiate.",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"description": "Kind of result.",
"default": "pagespeedonline#result"
},
"pageStats": {
"type": "object",
"description": "Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.",
"properties": {
"cssResponseBytes": {
"type": "string",
"description": "Number of uncompressed response bytes for CSS resources on the page.",
"format": "int64"
},
"flashResponseBytes": {
"type": "string",
"description": "Number of response bytes for flash resources on the page.",
"format": "int64"
},
"htmlResponseBytes": {
"type": "string",
"description": "Number of uncompressed response bytes for the main HTML document and all iframes on the page.",
"format": "int64"
},
"imageResponseBytes": {
"type": "string",
"description": "Number of response bytes for image resources on the page.",
"format": "int64"
},
"javascriptResponseBytes": {
"type": "string",
"description": "Number of uncompressed response bytes for JS resources on the page.",
"format": "int64"
},
"numberCssResources": {
"type": "integer",
"description": "Number of CSS resources referenced by the page.",
"format": "int32"
},
"numberHosts": {
"type": "integer",
"description": "Number of unique hosts referenced by the page.",
"format": "int32"
},
"numberJsResources": {
"type": "integer",
"description": "Number of JavaScript resources referenced by the page.",
"format": "int32"
},
"numberResources": {
"type": "integer",
"description": "Number of HTTP resources loaded by the page.",
"format": "int32"
},
"numberStaticResources": {
"type": "integer",
"description": "Number of static (i.e. cacheable) resources on the page.",
"format": "int32"
},
"otherResponseBytes": {
"type": "string",
"description": "Number of response bytes for other resources on the page.",
"format": "int64"
},
"textResponseBytes": {
"type": "string",
"description": "Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.",
"format": "int64"
},
"totalRequestBytes": {
"type": "string",
"description": "Total size of all request bytes sent by the page.",
"format": "int64"
}
}
},
"responseCode": {
"type": "integer",
"description": "Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.",
"format": "int32"
},
"score": {
"type": "integer",
"description": "The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.",
"format": "int32"
},
"screenshot": {
"type": "object",
"description": "Base64-encoded screenshot of the page that was analyzed.",
"properties": {
"data": {
"type": "string",
"description": "Image data base64 encoded.",
"format": "byte"
},
"height": {
"type": "integer",
"description": "Height of screenshot in pixels.",
"format": "int32"
},
"mime_type": {
"type": "string",
"description": "Mime type of image data. E.g. \"image/jpeg\"."
},
"width": {
"type": "integer",
"description": "Width of screenshot in pixels.",
"format": "int32"
}
}
},
"title": {
"type": "string",
"description": "Title of the page, as displayed in the browser's title bar."
},
"version": {
"type": "object",
"description": "The version of PageSpeed used to generate these results.",
"properties": {
"major": {
"type": "integer",
"description": "The major version number of PageSpeed used to generate these results.",
"format": "int32"
},
"minor": {
"type": "integer",
"description": "The minor version number of PageSpeed used to generate these results.",
"format": "int32"
}
}
}
}
}
},
"resources": {
"pagespeedapi": {
"methods": {
"runpagespeed": {
"id": "pagespeedonline.pagespeedapi.runpagespeed",
"path": "runPagespeed",
"httpMethod": "GET",
"description": "Runs PageSpeed analysis on the page at the specified URL, and returns a PageSpeed score, a list of suggestions to make that page faster, and other information.",
"parameters": {
"filter_third_party_resources": {
"type": "boolean",
"description": "Indicates if third party resources should be filtered out before PageSpeed analysis.",
"default": "false",
"location": "query"
},
"locale": {
"type": "string",
"description": "The locale used to localize formatted results",
"pattern": "[a-zA-Z]+(_[a-zA-Z]+)?",
"location": "query"
},
"rule": {
"type": "string",
"description": "A PageSpeed rule to run; if none are given, all rules are run",
"pattern": "[a-zA-Z]+",
"repeated": true,
"location": "query"
},
"screenshot": {
"type": "boolean",
"description": "Indicates if binary data containing a screenshot should be included",
"default": "false",
"location": "query"
},
"strategy": {
"type": "string",
"description": "The analysis strategy to use",
"enum": [
"desktop",
"mobile"
],
"enumDescriptions": [
"Fetch and analyze the URL for desktop browsers",
"Fetch and analyze the URL for mobile devices"
],
"location": "query"
},
"url": {
"type": "string",
"description": "The URL to fetch and analyze",
"required": true,
"pattern": "(?i)http(s)?://.*",
"location": "query"
}
},
"parameterOrder": [
"url"
],
"response": {
"$ref": "Result"
}
}
}
}
}
}
|
