GET /API/Pagespeed/

Basic Intro

Returns your existing Pagespeed tests from your account. NOTE: Authentication and a valid plan required

Parameters
Parameter Type Restrictions Description Required
id Integer - The ID of the test - Leave empty to retrieve all tests. No

Response Codes

Success

  • HTTP 200 - Success - Results can be found in the output

User Error

  • HTTP 400 - Request Failed - Generic Error: Please check output for more information.
  • HTTP 404 - Not Found - Nothing was found on this account.
  • HTTP 405 - Invalid Method - Invalid method used. Only supports GET.

Account Issues

  • HTTP 401 - Authorization Required - Provide Correct Username and API key
  • HTTP 402 - Payment Required - You do not have access to this function. Check your account for more information.
  • HTTP 429 - API Usage Limit Exceeded - Your limit was exceeded. Check your account for more information.

Example Output

The output is returned as a json array

Result of request without ID.
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": [
        {
            "ID": 15623,                        // Unique Test ID
            "Title": "Test test",               // Name of the test
            "URL": "http://www.mustek.be",      // URL of the site to be tested
            "Location": "PAGESPD-UK5",          // Assigned server that tests will be conduced from
            "Location_ISO": "UK",               // 2-letter ISO code of assigned server
            "ContactGroups": [],                // Array of contactgroup IDs
            "LatestStats": {
                "Loadtime_ms": 209,             // Latest recorded loadtime in ms
                "Filesize_kb": 160.513,         // Latest recorded filesize in kb
                "Requests": 8,                  // Latest recored request count
            }
        },
        { … }
    ]
}
Result of request with ID.
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": {
        "id": 12345,                                // Unique Test ID
        "name": "Example Pagespeed Test",           // Name of the test
        "website_url": "https://www.example.com",   // URL of the site to be tested
        "location": "PAGESPD-UK1",                  // Assigned server that tests will be conduced from
        "location_iso": "UK",                       // 2-letter ISO code of assigned server
        "checkrate": 15,                            // Checkrate in minutes
        "contact_groups": [],                       // Array of contactgroup IDs.
        "alert_smaller": 0,                         // Minimum threshold for size (kb)
        "alert_bigger": 0,                          // Maximum threshold for size (kb)
        "alert_slower": 0,                          // Maximum threshold for loadtime (ms)
        "latest_stats": {                       
            "Loadtime_ms": 209,                 // Latest recorded loadtime in ms
            "Filesize_kb": 160.513,                 // Latest recorded filesize in kb
            "Requests": 8,                          // Latest recored request count
            "has_issue": false,                     // True if last test exceeded thresholds
            "latest_issue": "The Total Load Time of the Page (217/ms) is larger than the alert threshold of 100/ms" // Description of last issue. See "has_issue".
        }
    }
}