Skip to main content
POST
Report one desktop app launch

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Body

application/json
attemptId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
appVersion
string
required
Required string length: 1 - 64
Pattern: ^[0-9A-Za-z][0-9A-Za-z.+_-]{0,63}$
platform
enum<string>
required
Available options:
darwin,
win32,
linux,
other
observedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
success
boolean
required
steps
object
required
failedStep
enum<string> | null
required
Available options:
window,
engine,
signed_in,
org_tools
reason
enum<string> | null
required
Available options:
certificate,
dns,
offline,
timeout,
connection_refused,
server_error,
signed_out,
session_expired,
engine_failed,
org_unavailable,
unknown

Response

Recorded, already recorded, or ignored.