Get a test screen event
get/v1/test_helpers/screen_events/{test_screen_event_id}
queued (accepted), sending (going out now), sent (the Harvester events went out), or failed (failure says why).
Access
- Authentication
- Secret key or OAuth access token.
- Scope
test_helpers:write- User permission
developerAccess
Path parameters
test_screen_event_idstringRequired
Headers
Vojo-VersionstringOptional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the
Vojo-Versionresponse header. Within/v1only additive changes ship, so most callers can omit it.
Response 200
OK
dataobjectRequiredShow 8 fields
idstringRequiredPrefixed
tsev_.typestringRequiredstatusstringRequiredscreen_idstringRequiredfailureobject or nullRequiredShow 2 fields
codestringRequiredmessagestringRequired
created_atstringRequiredsent_atstring or nullRequiredlivemodebooleanAlways false.
metaobjectRequired
Response headers
Vojo-VersionstringThe API version (date) this response was rendered with — the request's
Vojo-Version, else the key/org pin.RateLimitstringIETF RateLimit header: remaining quota in the current window, e.g.
"default";r=97;t=42.RateLimit-PolicystringIETF RateLimit-Policy header, e.g.
"default";q=100;w=60. Portal OAuth clients get a higher tier.
Errors
Every error is application/problem+json. Branch on its code.
- 401
Missing, invalid, expired or revoked credential.
- 403
The caller is authenticated but not allowed: missing scope (
insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied). - 404
The resource does not exist, or belongs to another organisation. Cross-org ids always 404, never 403.
- 429
Rate limit exceeded for this principal. Back off for
Retry-Afterseconds. - 500
Unexpected server failure.