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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Samples — Battelrite 0.2 documentation</title>
<link rel="stylesheet" href="../_static/css/battlerite.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Telemetry" href="../telemetry/telemetry.html" />
<link rel="prev" title="Players" href="../players/players.html" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
</head>
<body>
<header id="BTT" role="banner">
<div class="menu-top-outer clearfix">
<div class="wrapper clearfix">
<a href="/" id="site-logo"></a>
<span id="logSignBtn" class="btn">Login / Signup</span>
<nav id="mainMenu" class="main-menu-con">
<ul class="main-menu clearfix">
<li><a class="active" href="guides.html">Documentation</a></li>
<li><a href="faq.html">Faqs</a></li>
<li><a href="creations.html">Creations</a></li>
</ul>
</nav>
</div>
</div>
</header>
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="../players/players.html" title="Previous document">Players</a>
</li>
<li>
<a href="../telemetry/telemetry.html" title="Next document">Telemetry</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="samples">
<span id="id1"></span><h1>Samples<a class="headerlink" href="#samples" title="Permalink to this headline">¶</a></h1>
<p>The samples endpoint provides an easy way to access hourly batches of random match data to aggregate stats.</p>
<div class="section" id="get-a-collection-of-samples">
<h2>Get a Collection of Samples<a class="headerlink" href="#get-a-collection-of-samples" title="Permalink to this headline">¶</a></h2>
<p>This endpoint retrieves a collection of randomly selected matches.</p>
<p><strong>HTTP Request</strong></p>
<div class="line-block">
<div class="line"><code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/shards/na/samples</span></code></div>
</div>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="10%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Default</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>page[offset]</td>
<td>0</td>
<td>Allows paging over results</td>
</tr>
<tr class="row-odd"><td>page[limit ]</td>
<td>50</td>
<td>The default (and current maximum) is 50.Values less than 50 and great than 2 are supported.</td>
</tr>
<tr class="row-even"><td>sort</td>
<td>createdAt</td>
<td>By default, Matches are sorted by creation time ascending.</td>
</tr>
<tr class="row-odd"><td>filter[createdAt-start]</td>
<td>none</td>
<td>Must occur before end time. Format is iso8601 Usage: filter[createdAt-start]=2017-01-01T08:25:30Z</td>
</tr>
<tr class="row-even"><td>filter[createdAt-end]</td>
<td>none</td>
<td>Queries search the last 3 hrs. Format is iso8601 i.e.filter[createdAt-end]=2017-01-01T13:25:30Z</td>
</tr>
</tbody>
</table>
<p><strong>Python:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/samples"</span> \
<span class="o">-</span><span class="n">H</span> <span class="s2">"Authorization: Bearer <api-key>"</span> \
<span class="o">-</span><span class="n">H</span> <span class="s2">"Accept: application/vnd.api+json"</span>
<span class="o">//</span><span class="n">The</span> <span class="n">above</span> <span class="n">command</span> <span class="n">returns</span> <span class="n">JSON</span> <span class="n">structured</span> <span class="n">like</span> <span class="n">this</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"sample"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"sample-na-2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"URL"</span><span class="p">:</span> <span class="s2">"URL of Sample Matches"</span><span class="p">,</span>
<span class="s2">"createdAt"</span><span class="p">:</span> <span class="s2">"2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"shardId"</span><span class="p">:</span> <span class="s2">"na"</span><span class="p">,</span>
<span class="s2">"t0"</span><span class="p">:</span> <span class="s2">"2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"t1"</span><span class="p">:</span> <span class="s2">"2017-02-28T08:15:30Z"</span><span class="p">,</span>
<span class="s2">"titleId"</span><span class="p">:</span> <span class="s2">"semc-vainglory"</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"assets"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="p">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Javascript:</strong></p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="c1">//There are a variety of Java HTTP libraries that support query-parameters.</span>
<span class="nx">curl</span> <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/samples"</span> <span class="o">\</span>
<span class="o">-</span><span class="nx">H</span> <span class="s2">"Authorization: Bearer <api-key>"</span> <span class="o">\</span>
<span class="o">-</span><span class="nx">H</span> <span class="s2">"Accept: application/vnd.api+json"</span>
<span class="c1">//The above command returns JSON structured like this:</span>
<span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"sample"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"sample-na-2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"URL"</span><span class="o">:</span> <span class="s2">"URL of Sample Matches"</span><span class="p">,</span>
<span class="s2">"createdAt"</span><span class="o">:</span> <span class="s2">"2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"shardId"</span><span class="o">:</span> <span class="s2">"na"</span><span class="p">,</span>
<span class="s2">"t0"</span><span class="o">:</span> <span class="s2">"2017-02-28T07:15:30Z"</span><span class="p">,</span>
<span class="s2">"t1"</span><span class="o">:</span> <span class="s2">"2017-02-28T08:15:30Z"</span><span class="p">,</span>
<span class="s2">"titleId"</span><span class="o">:</span> <span class="s2">"semc-vainglory"</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"assets"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../datacenters/datacenters.html">Datacenters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authorization/authorization.html">Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../titles/titles.html">Titles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../makingrequests/makingrequests.html">Making Requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../receivingresponses/receivingresponses.html">Receiving Responses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../matches/matches.html">Matches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../match_data_summary/match_data_summary.html">Match Data Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../players/players.html">Players</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Samples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#get-a-collection-of-samples">Get a Collection of Samples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../telemetry/telemetry.html">Telemetry</a></li>
<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../links/links.html">Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="../community_sdks/community_sdks.html">Community SDKs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../errors/errors.html">Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog/changelog.html">Changelog</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="../players/players.html" title="Previous document">Players</a>
</li>
<li>
<a href="../telemetry/telemetry.html" title="Next document">Telemetry</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
</body>
</html>
|
