Skip to main content
POST
Explain what went wrong for a user

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
userID
string
required

Observe user ID (format tus-<number>), returned by user search.

actionID
string

Explain this attempt (format sfl-<number>) instead of selecting the latest supported attempt. Takes precedence over onlyFailed. The attempt must belong to the requested user's activity.

onlyFailed
boolean
default:false

Select the latest supported attempt that did not complete. Ignored when actionID is supplied.

recoveryWindowMinutes
integer

Time window after the selected attempt's start in which a later successful journey of the same type counts as recovery. Defaults to 60 minutes; accepts 1 to 10080. The attempt's own journey always counts.

Required range: 1 <= x <= 10080

Response

Explanation and support context for the selected attempt.

Support explanation and the context needed to investigate the selected attempt.

diagnosis
object
required
Example: