Provenance for a complete report produced from Rocket League's live Game Data API.
Properties
collectorVersion
string
Required
Version of the Postmatch collector that assembled this report.
maxLength: 128 bytesminLength: 1 bytesendEvidence
string
Required
Evidence used to decide that the match was complete. match-ended-event means Rocket League emitted MatchEnded. score-derived means teardown arrived without MatchEnded and the collector inferred completion only from a decisive overtime score or a non-tied regulation score at zero seconds.
finalSnapshot
string
Required
Where the final scoreboard snapshot sat relative to an observed MatchEnded event. after-match-ended is the usual case. before-match-ended means the accumulated last in-match snapshot was used; endEvidence says whether MatchEnded was observed or completion was score-derived.
source
string
Required
Source API used for this observation.
transport
string
Required
Transport used to receive the live frames.
View raw schema
{
"type": "object",
"required": [
"source",
"transport",
"collectorVersion",
"endEvidence",
"finalSnapshot"
],
"properties": {
"source": {
"type": "string",
"const": "rocket-league-game-data-api",
"description": "Source API used for this observation."
},
"transport": {
"type": "string",
"const": "websocket",
"description": "Transport used to receive the live frames."
},
"endEvidence": {
"enum": [
"match-ended-event",
"score-derived"
],
"type": "string",
"description": "Evidence used to decide that the match was complete. match-ended-event means Rocket League emitted MatchEnded. score-derived means teardown arrived without MatchEnded and the collector inferred completion only from a decisive overtime score or a non-tied regulation score at zero seconds."
},
"finalSnapshot": {
"enum": [
"after-match-ended",
"before-match-ended"
],
"type": "string",
"description": "Where the final scoreboard snapshot sat relative to an observed MatchEnded event. after-match-ended is the usual case. before-match-ended means the accumulated last in-match snapshot was used; endEvidence says whether MatchEnded was observed or completion was score-derived."
},
"collectorVersion": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Version of the Postmatch collector that assembled this report."
}
},
"description": "Provenance for a complete report produced from Rocket League's live Game Data API."
}