API Documentation

Available fields:

• "status" - 'QUEUED','RUNNING','FINISHED','FAILED' or 'CANCELED'
• "result" - 'PASSED','FAILED','SKIPPED' or 'ERROR'
• "retries" - number of retries of this test, integer

Lists all pages from your organization

Page "url" can be a relative URL (for example "/about", in that case production, staging or development domain configured for a website will be used, or "url" can be set to an absolute URL (for example "https://example.com").

Setting "paused_at" to any non-null value will pause the page and it will be excluded from all future comparisons.

NOT async, takes up to 45s

url parameter accepts special syntax for making screenshots of pages that depend on scroll.

For example:

• https://www.example.com/@!0,2 - scroll the page 2 screen heights vertically before taking a screenshot.
• https://www.example.com/@0,1000 - scroll the page 1000px vertically.
• https://www.example.com/@!.container,0,1 - scroll the page 1 screen height down relative to the top of a .container element on the page

You can also supply credentials for the Basic HTTP authentication - https://user:password@example.com

Generates a single image with previous, current and difference Screenshots side-by-side. Can be used in notifications.

Shows notifications (Email, Slack) that would be send for this testrun.

Deletes sent Slack notifications for this testrun. Works only if Slack was connected via OAuth2, doesn't work for Webhook connections.

Marks test run as canceled, stops all queued comparison from further processing, but allows already running ones to finish.

Resumes cancelled test run by adding all canceled comparisons to processing queue.

Starts a new test, returns test run id:

Example response:

{
          "test_run_id": 4388
          }
          

Example response:

{
          "data": [
          {
          "id": 21,
          "created_at": "2024-09-03T11:12:33.059Z",
          "updated_at": "2024-09-03T11:12:33.059Z",
          "project_id": 15,
          "name": "Test Name",
          "test_history": "NONE",
          "test_compare_from": "PROD",
          "test_compare_to": "NONE",
          "test_errors": "NONE",
          "page_groups": [
          {
          "id": 21,
          "description": "All Pages",
          "created_at": "2024-09-03T11:12:33.052Z",
          "updated_at": "2024-09-03T11:12:33.052Z",
          "website_id": 15,
          "page_group_manager_id": 4
          }
          ]
          }
          ],
          "total_count": 1
          }
          

Example response:

{
          "data": {
          "id": 16,
          "login": "user1",
          "name": "Test user",
          "email": "",
          "created_at": "2024-09-03T11:12:33.033Z",
          "updated_at": "2024-09-03T11:12:33.033Z",
          "organization_id": 1,
          "organization": {
          "id": 1,
          "name": "Org Name",
          "created_at": "2024-09-03T11:12:33.004Z",
          "updated_at": "2024-09-17T10:22:30.061Z",
          }
          }
          }