Skip to content

Submit client telemetry

POST
/v1/report

Optional reporting of update checks and outcomes

object
productId
string
version
string
checkTimestamp
string format: date-time
action
string
Allowed values: NONE NOTIFY DOWNLOAD INSTALL
outcome
string
Allowed values: SUCCESS FAILED SKIPPED
error

Error message if outcome is FAILED

string

Telemetry accepted

object
accepted
boolean
timestamp
string format: date-time

Bad request

object
code
required
string
message
required
string
details
object
key
additional properties
any
Example
{
"code": "BAD_REQUEST",
"message": "Invalid request parameters"
}

Internal server error

object
code
required
string
message
required
string
details
object
key
additional properties
any
Example
{
"code": "INTERNAL_ERROR",
"message": "An internal error occurred"
}