Tests

Trigger a test run

View as Markdown

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

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

testIdstringRequiredformat: "uuid"
Test ID

Request

This endpoint expects an object.
modeenumOptional
Allowed values:
platformenumOptional

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.

Allowed values:
deviceModelenumOptional

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.

Allowed values:
appIdstringOptionalformat: "uuid"
projectEnvironmentIdstringOptionalformat: "uuid"

Response

Test run queued successfully
statusenum
runIdstringformat: "uuid"
testIdstringformat: "uuid"

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error