POST /API/Pagespeed/Update

Basic Intro

Update an existing Pagespeed test on your account. NOTE: Authentication and a valid plan required

Parameters

ID is required, without it a new test will be created! Optional parameters should not be included if they are to remain unchanged, include but leave empty to erase them

Parameter Type Restrictions Description Required
id Integer Positive numbers only Unique ID of the test YES
website_url String Must be a valid URL URL that should be checked No
location_iso String Valid: PRIVATE, AU, CA, DE, IN, NL, SG, UK, US 2-letter ISO code of the location No
private_name String Must select PRIVATE in location_iso. Must have private server Name of private server [NOT YET IMPLEMENTED] No
checkrate Integer Valid: 1, 5, 10, 15, 30, 60, 1440 [Plan restrictions apply] Checkrate in minutes No
contact_groups String String of positive integers, separated with a comma. IDs of selected Contact Groups. No
alert_smaller Integer Positive numbers only. Set to 0 to disable. Size in kb, will alert to Contact Groups if actual size is smaller. No
alert_bigger Integer Positive numbers only. Set to 0 to disable. Size in kb, will alert to Contact Groups if actual size is bigger. No
alert_slower Integer Positive numbers only. Set to 0 to disable. Time in ms, will alert to Contact Groups if actual time is slower. No

Response Codes

Success

  • HTTP 200 - Success - The test has been updated successfully.

User Error

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

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

{
    "success": true,    // Returns false on error
    "message": "",      // Additional information, if available
    "data": []          // Unused
}