Instant Test API

Methods for running instant test jobs. An instant test is a quick check of a URL containing basic load information.

Method summary

create()

  Create a new instant test and return the id

get()

  Retrieve information for an instant test

get_by_location()

  Retrieve information for an instant test by location

create

create(string url, string callback)

Create a new instant test and return the id of the new job. You may optionally supply a callback url, to which we will POST the current status for every stage of the instant test process

Arguments:

  url - The url to test

  (optional) callback - A callback url to post results to

Example:

c.instanttest().create('https://www.example.com', 'https://www.myapi.com')

get

get()

Retrieve information for an instant test, along with information from each location being tested

Example:

c.instanttest('job_id').get()

get_by_location

get_by_location(string location)

Retrieve information for an instant test by location

Arguments:

  location - Location to query

Example:

c.instanttest('job_id').get_by_location('washingtondc')