API Version History

The Rigor Optimization API uses version strings in the request URL to preserve backward compatibility. All methods follow the following URL structure:

(GET | POST | PUT | DELETE) https://optimization-api.rigor.com/{version}/{Path}

For example:

GET https://optimization-api.rigor.com/v2/Tests

New versions will be introduced only if breaking changes are necessary, otherwise revisions to existing versions will be published below. While we will endeavor to minimize breaking changes, we must also remain committed to keeping the API easy to use and powerful in the future. Rest assured legacy versions, if discontinued, will not be done so without ample warning.

What is a Breaking Change?

MethodInput ParametersResponse Bodies
Breaking Change: Existing methods removed or renamed Required input parameters added, removed or renamed Existing response fields removed, renamed, or change nesting level
Non-Breaking Change: New methods added New optional inputs added New response fields added

Version History

Version 2 (Latest)

View Latest Version

Updated: January 28, 2019
  • Added impact_type filter to Get Defects method.
Updated: December 14, 2018
  • New Accounts method Get Account Usage now available to query current usage and licensing status.
Updated: December 1, 2018
  • Get Snapshot Detail call can now optionally generate and return video and screen capture links.
Updated: November 27, 2018
  • Webhook notifications added to Create New Snapshot call. Postback payload is that used in the Get Snapshot Detail call.
Updated: November 20, 2018
  • Added new timing metrics to Get Snapshot Detail results: time_domcomplete, time_dominteractive, time_firstpaint, time_firstcontentfulpaint, time_firstmeaningfulpaint, time_interactive
Updated: September 7, 2018
  • Get Accounts and Get Account Detail endpoints now accessible to all user permission levels (for permissable accounts only).
Updated: May 10, 2018
  • You can now set and view custom cookies, headers and dns overrides in Create Test, Update Test, and Get Test API calls.
Updated: April 17, 2018
  • Added browser to TestSummary payload for Get Test Detail.
  • DeviceType enum updated with latest supported device versions.
Updated: April 11, 2018
  • Added new optional user_name field to various User methods.
Updated: March 14, 2018
  • Added scan_completed_utc to SnapshotSummary response to allow for scan begin/end times to be referenced.
  • Also added latest_snapshot_time_utc and latest_snapshot_complete_time_utc to TestSummary response for same reason.
Updated: March 8, 2018
  • Added new optional client_option filtering option to Get Accounts call.
Updated: February 26, 2018
  • Added snapshot_limit_detail, snapshots_limit_total, and snapshots_remain_total to AccountSummary and ClientSummary responses.
Updated: January 12, 2018
  • New interfaces released for administration: Users and Accounts. (Requires client administrator access).
  • New ACCOUNT-KEY header accepted for multi-account access. (Optional, calls will default to existing/default account if not provided).
  • Add owner_user_id filter for Get Tests and including owner_user_id in Get Tests results.
Updated: December 11, 2017
  • Added regions parameter to Test methods to run location specific tests.
  • Added connection_speed parameters to Test methods to allow customization of connection speed used for tests.
Updated: August 30, 2017
  • Bug fix: Update Existing Tests was always resetting scan type to WebPage. Now throws error if scan type is changed.
Updated: August 8, 2017
  • Added SnapshotPage metrics to Get Snapshot Detail call. (HAR urls, page timings)
  • Added body_transfer_size to Content calls.
  • Get Snapshots and Get SnapshotDetail now return item_bytes_1PC and item_bytes_3PC as total transfer size rather then total content size.
Updated: Feb 21, 2017
  • Added size_with_lossless and size_with_lossy to Get Snapshots and Get Snapshot Detail results
  • Added defect_count_*_all to Get Snapshots and Get Snapshot Detail results
  • Added new sort options to Get Snapshots: TotalSize, SizeWithLossy, SizeWithLossless
Updated: January 9, 2017
  • Added new Custom device type to Test model
  • Added user_agent field for Test GET, POST, and PUT endpoints
Updated: Sep 6, 2016
  • Added new Update Snapshots method, including support for tagging
  • Extended Create New Snapshot method to optionally take tag inputs and return created tags.
  • Extended Get Snapshots and Get Snapshot Detail to optionally filter by tags and return tag details
  • Extended Create New Test to optionally take tag inputs and return created tags.
  • Extended Get Snapshots and Get Snapshot Detail to return screenshot_url
  • Extended Get Tests and Get Test Detail to optionally filter by tags and return tag details
  • Extended Get Tests with many new filters and returned values to match what's in the View Results view
Updated: May 25, 2016
  • API root URL changed to https://optimization-api.rigor.com from https://api.zoompf.com (old queries will be auto-redirected).
Updated: May 2, 2016
  • Added new optional filters to Get Defects: name, visibility, defect_ids and status.
  • Added new Defects method: Update Defects.
  • Added new DefectPolicy functions to manage Defect Policies.
  • Added new DefectPolicyChecks functions to manage Defect Policy Checks.
Updated: February 15, 2016
  • Added additional results to SnapshotSummary response (savingspct_*, item_*, defects_*).
Updated: February 12, 2016
  • Added new optional from/to/range time filters to Get Snapshots call.
Released: January 11, 2016
  • New comprehensive RESTful API launched!
  • CRUD operations for Performance Tests, Snapshots, Defects and Content
  • JSON and XML payloads