APIHub
Back to Explore

Crossbrowsertesting.com Screenshot Comparisons API

What's in this version: 1. Compare two screenshots for layout differences 2. Compare a full screenshot test of browsers to a single baseline browser for layout differences. 3. Compare a screenshot test version to another test version - good for regression tests. 4. Get links to the Comparison UI for visual representation of layout differences

Development
basic
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}

Compare Screenshot Test Versions

  • target_screenshot_test_id (path, required) — test id of the target Screenshot Test
  • target_version_id (path, required) — version id of the target Screenshot Test
  • base_version_id (path, required) — version id of the base Screenshot Test
  • format (query) — The format of the returned data. Possible values are "json" or "jsonp".
  • callback (query) — Name of callback method for JSONP requests.
  • tolerance (query) — Used as the basis for detecting box model differences in element positioning and dimensions that should be flagged and reported back to the comparison results. The default is 30px which is a good basis for finding notable layout differences.
GET

/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}

Compare Full Screenshot Test

  • target_screenshot_test_id (path, required) — test id of the target Screenshot Test
  • target_version_id (path, required) — version id of the target Screenshot Test
  • base_result_id (path, required) — result id of the base Screenshot Test
  • format (query) — The format of the returned data. Possible values are "json" or "jsonp".
  • callback (query) — Name of callback method for JSONP requests.
  • tolerance (query) — Used as the basis for detecting box model differences in element positioning and dimensions that should be flagged and reported back to the comparison results. The default is 30px which is a good basis for finding notable layout differences.
GET

/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}

Compare Single Screenshot

  • target_screenshot_test_id (path, required) — test id of the target Screenshot Test
  • target_version_id (path, required) — version id of the target Screenshot Test
  • target_result_id (path, required) — result id of the target Screenshot Test
  • base_result_id (path, required) — result id of the base Screenshot Test
  • format (query) — The format of the returned data. Possible values are "json" or "jsonp".
  • callback (query) — Name of callback method for JSONP requests.
  • tolerance (query) — Used as the basis for detecting box model differences in element positioning and dimensions that should be flagged and reported back to the comparison results. The default is 30px which is a good basis for finding notable layout differences.

3 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://crossbrowsertesting.com/api/v3/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}"

crossbrowsertesting.com · HTTPS only