Pagespeed

get
Get Pagespeed data for a URL

https://raileo.com/api/v1/urls/:id/pagespeed
Get recent pagespeed scan results for a URL. Latest 10 reports are selected by default.
Request
Response
Request
Path Parameters
id
required
integer
URL id
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Response
200: OK
Cake successfully retrieved.
{
"data": [
{
"id": 123,
"device_type": "desktop",
"first_contentful_paint": "0.8 s",
"first_cpu_idle": "1.5 s",
"speed_index": "3.0 s",
"time_to_interact": "1.7 s",
"first_meaningful_paint": "1.0 s",
"accessibility_score": "83",
"pwa_score": "31",
"performance_score": "78",
"best_practices_score": "85",
"seo_score": "90",
"notes": "Added UTM Parameters",
"created_at": "2019-11-26 17:12:45"
},
{
"id": 110,
"device_type": "desktop",
"first_contentful_paint": "0.9 s",
"first_cpu_idle": "1.2 s",
"speed_index": "3.2 s",
"time_to_interact": "1.6 s",
"first_meaningful_paint": "1.0 s",
"accessibility_score": "83",
"pwa_score": "31",
"performance_score": "77",
"best_practices_score": "92",
"seo_score": "90",
"notes": "Modified search results with proximity",
"created_at": "2019-10-22 12:39:46"
},
]
}
404: Not Found
Could not find a cake matching this query.
{
"error": {
"message": {
"message": "No data found"
},
"status_code": 404
}
}

get
Get complete pagespeed report

https://raileo.com/api/v1/:id/pagespeed/:report_id
This endpoints gives a detailed pagespeed scan report.
Request
Response
Request
Path Parameters
report_id
required
number
Page speed Report ID
id
required
number
First Parameter is the URL ID
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Response
200: OK
{
"data": {
"device_type": "desktop",
"first_contentful_paint": "0.6 s",
"first_cpu_idle": "2.2 s",
"speed_index": "1.4 s",
"time_to_interact": "2.3 s",
"first_meaningful_paint": "0.6 s",
"accessibility_score": "72",
"pwa_score": "73",
"performance_score": "93",
"best_practices_score": "77",
"seo_score": "90",
"notes": "Automated monitoring at 2019-12-07 04:21:20",
"created_at": "2019-12-07 04:21:20",
"report": {
"requestedUrl": "https://example.com/",
"finalUrl": "https://example.com/",
"lighthouseVersion": "5.6.0",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/77.0.3865.99 Safari/537.36",
"fetchTime": "2019-12-07T04:21:04.051Z",
"environment": {
"networkUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3694.0 Safari/537.36 Chrome-Lighthouse",
"hostUserAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/77.0.3865.99 Safari/537.36",
"benchmarkIndex": 510
},
"runWarnings": [],
"configSettings": {
"emulatedFormFactor": "desktop",
"locale": "en-US",
"onlyCategories": [
"pwa",
"performance",
"accessibility",
"best-practices",
"seo"
]
},
...
}
}
}

post
Run new Pagespeed scan

https://raileo.com/api/v1/pagespeed
Start a new Pagespeed scan for a URL
Request
Response
Request
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Form Data Parameters
device_type
optional
string
Options are desktop or mobile. If no device_type is passed, desktop is taken as default.
url_id
required
number
Id of the URL for the pagespeed scan
Response
200: OK
{
"data": {
"first_contentful_paint": "2.3 s",
"first_meaningful_paint": "2.3 s",
"first_cpu_idle": "8.9 s",
"speed_index": "6.3 s",
"time_to_interact": "10.2 s",
"accessibility_score": 84,
"pwa_score": 67,
"performance_score": 47,
"best_practices_score": 85,
"seo_score": 99,
"notes": "Scan via API at 2019-12-08 08:50:50",
"device_type": "mobile"
}
}
404: Not Found
{
"error": {
"message": {
"message": "URL Not found"
},
"status_code": 404
}
}