summaryrefslogtreecommitdiff
path: root/source/match_data_summary/match_data_summary.rst
blob: a87682e512b3350982afa5918dbd631bdceea86b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
.. _match_data_summary:

Match Data Summary
==================

Special thanks to Kashz for helping to create this! GitHub: iAm-Kashif

Match Object
---------------------------

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
Type               str             Match
ID                 str             Match ID
createdAt          str (iso8601)   Time of Match Played
duration           int             Time of match in seconds
gameMode           str             Game Mode
patchVersion       str             Version of API
shardID            str             Match Shard
stats              map             See Match.stats
assets             obj             See Match.assets
rosters            obj             See Rosters
=================  ==============  ===========================


**Match.stats (End of game statistics)**

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
endGameReason      str             "Victory" or "Defeat"
queue              str             Game Mode
=================  ==============  ===========================


**Match.assets (Telemetry Data)**

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
Type               string          asset
createdAt          str (iso8601)   Time of Telemtry creation
description        str             " "
filename           str             telemetry.json
id                 str             ID of Asset
contentType        str             application/json
name               map             telemetry
url                obj             Link to Telemetry.json file
=================  ==============  ===========================


Rosters Object
---------------------------

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
id                 str             ID of Roster
type               str             Roster
participants       obj             See Participants
stats              obj             See Rosters.stats
team               obj             See Rosters.team
=================  ==============  ===========================


**Rosters.stats**

=================  =======================================
Variable    	   Type          
=================  =======================================
acesEarned         int           
gold               int  
heroKills          int           
krakenCaptures     int  
side               Either "right/red" or "left/blue"  
turretKills        int  
turretRemaining    int  
=================  =======================================


**Rosters.team**

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
id                 str             ID of Team or None
name               str             Name of Team or None
type               str             team
=================  ==============  ===========================

Participants Object
---------------------------

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
actor              str             Hero
id                 str             Same as ID of Roster
player             obj             See Participants.player
stats              map             See Paticipants.stats
type               str             participants
=================  ==============  ===========================

**Participants.player**

=================  ==============  ===========================
Variable    	   Type            Description
=================  ==============  ===========================
id                 str             UID of player
name               str             IGN of player
stats              map             See Participants.player.stats
type              str             palyer
=================  ==============  ===========================

**Particpants.stats**

======================  =================================
Variable    	        Type          
======================  =================================
assists	                int
crystalMineCaptures    	int
deaths	                int
farm                	int
firstAfkTime        	int: -1 for no AFK
goldMineCaptures	    int
itemGrants          	map of {itemsBought : int}
itemSells	            map of {itemsSold : int}
itemUses	            map of {itemsUsed : int}
items	                list of final build (Len: 6)
jungleKills          	int
karmaLevel	            int
kills	                int
krakenCaptures         	int
level	                int
minionKills         	int
nonJungleMinionKills	int
skillTier             	int
skinKey             	str
turretCaptures	        int
wentAfk	                bool
winner              	bool
======================  =================================


**Particpants.player.stats**

======================  =================================
Variable    	        Type          
======================  =================================
level	                int
lifetimeGold         	float
lossStreak            	int
played               	int
played_ranked          	int
winStreak               int
wins                	int
xp	                    int
======================  =================================


.. toctree::
  :maxdepth: 2