latestOpenAPI 3.1.02026-08-2251540275.6 KB

bf198f94879a

tests

Trigger a test run

Trigger a saved dashboard test remotely using API-key authentication. Returns the queued run ID.

post/v1/tests/{testId}/runs

Path parameters

testIdstring uuid required

Test ID

Headers

Authorizationstring required

API key authentication using Bearer token format

Request body

mode'fast' | 'deep'

platform'web' | 'ios' | 'android'

Run platform for the test. Mobile tests default to ios when omitted, so Android runs must set platform: android — including when the mobile app is selected by appId.

deviceModel'iphone' | 'ipad'

Mobile device variant within the run platform (iOS: iphone | ipad). Omit for the platform default phone-sized device; explicitly requesting the default (e.g. iphone) is equivalent to omitting it.

appIdstring uuid

projectEnvironmentIdstring uuid

Response

Test run queued successfully

status'queued' required

runIdstring uuid required

testIdstring uuid required