summaryrefslogtreecommitdiff
path: root/build/html/matches/matches.html
diff options
context:
space:
mode:
Diffstat (limited to 'build/html/matches/matches.html')
-rw-r--r--build/html/matches/matches.html483
1 files changed, 483 insertions, 0 deletions
diff --git a/build/html/matches/matches.html b/build/html/matches/matches.html
new file mode 100644
index 0000000..7bf205c
--- /dev/null
+++ b/build/html/matches/matches.html
@@ -0,0 +1,483 @@
+
+<!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>Matches &#8212; 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="Match Data Summary" href="../match_data_summary/match_data_summary.html" />
+ <link rel="prev" title="Receiving Responses" href="../receivingresponses/receivingresponses.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>
+ &larr;
+ <a href="../receivingresponses/receivingresponses.html" title="Previous document">Receiving Responses</a>
+ </li>
+ <li>
+ <a href="../match_data_summary/match_data_summary.html" title="Next document">Match Data Summary</a>
+ &rarr;
+ </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="matches">
+<span id="id1"></span><h1>Matches<a class="headerlink" href="#matches" title="Permalink to this headline">¶</a></h1>
+<p>Matches records are created every time players complete a game session. Each Match contains high level information about the game session, including info like duration, gameMode, and more. Each Match has two Rosters.</p>
+<div class="section" id="rosters">
+<h2>Rosters<a class="headerlink" href="#rosters" title="Permalink to this headline">¶</a></h2>
+<p>Rosters track the scores of each opposing group of Participants. If players entered matchmaking as a team, the Roster will have a related Team. Rosters have many Participants objects, one for each member of the Roster. Roster objects are only meaningful within the context of a Match and are not exposed as a standalone resource.</p>
+<p><strong>Javascript:</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;eca49808-d510-11e6-bf26-cec0c932ce01&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;attributes&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;stats&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;acesEarned&quot;</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">&quot;gold&quot;</span><span class="o">:</span> <span class="mi">32344</span><span class="p">,</span>
+ <span class="s2">&quot;etc...&quot;</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">&quot;relationships&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;team&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;data&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;team&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;753d464c-d511-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">&quot;participants&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;data&quot;</span><span class="o">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;participant&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;eca49a7e-d510-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="p">},</span>
+ <span class="s2">&quot;etc...&quot;</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="participants">
+<h2>Participants<a class="headerlink" href="#participants" title="Permalink to this headline">¶</a></h2>
+<p>Participant objects track each member in a Roster. Participants may be anonymous Players, registered Players, or bots. In the case where the Participant is a registered Player, the Participant will have a single Player relationship. Participant objects are only meaningful within the context of a Match and are not exposed as a standalone resource.</p>
+<p><strong>Javascript:</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;participant&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;ea77c3a7-d44e-11e6-8f77-0242ac130004&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;attributes&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;actor&quot;</span><span class="o">:</span> <span class="s2">&quot;*Hero009*&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;stats&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;assists&quot;</span><span class="o">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">&quot;crystalMineCaptures&quot;</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">&quot;deaths&quot;</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">&quot;farm&quot;</span><span class="o">:</span> <span class="mf">49.25</span><span class="p">,</span>
+ <span class="s2">&quot;etc...&quot;</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="get-a-collection-of-matches">
+<h2>Get a Collection of Matches<a class="headerlink" href="#get-a-collection-of-matches" title="Permalink to this headline">¶</a></h2>
+<p>This endpoint retrieves data from matches. Bulk scraping matches is prohibited.</p>
+<p><strong>HTTP Request</strong>
+| <code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/shards/na/matches</span></code></p>
+<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>3hrs ago</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>Now</td>
+<td>Queries search the last 3 hrs. Format is iso8601 i.e.filter[createdAt-end]=2017-01-01T13:25:30Z</td>
+</tr>
+<tr class="row-odd"><td>filter[playerNames]</td>
+<td>none</td>
+<td>Filters by player name. Usage: filter[playerNames]=player1,player2,…</td>
+</tr>
+<tr class="row-even"><td>filter[playerIds]</td>
+<td>none</td>
+<td>Filters by player Id. Usage:filter[playerIds]=playerId,playerId,…</td>
+</tr>
+<tr class="row-odd"><td>filter[teamNames]</td>
+<td>none</td>
+<td>Filters by team names. Team names are the same as the in game team tags. Usage: filter[teamNames]=TSM,team2,…</td>
+</tr>
+<tr class="row-even"><td>filter[gameMode]</td>
+<td>none</td>
+<td>Filter by gameMode Usage: filter[gameMode]=casual,ranked,…</td>
+</tr>
+</tbody>
+</table>
+<p><em>Remember — a happy match is an authenticated match!</em></p>
+<p><strong>Shell:</strong></p>
+<div class="highlight-shell"><div class="highlight"><pre><span></span> curl -g <span class="s2">&quot;https://api.dc01.gamelockerapp.com/shards/na/matches?sort=createdAt&amp;page[limit]=3&amp;filter[createdAt-start]=2017-02-27T13:25:30Z&amp;filter[playerNames]=&lt;playerName&gt;&quot;</span> <span class="se">\</span>
+ -H <span class="s2">&quot;Authorization: Bearer &lt;api-key&gt;&quot;</span> <span class="se">\</span>
+ -H <span class="s2">&quot;Accept: application/vnd.api+json&quot;</span>
+
+ //The above <span class="nb">command</span> returns JSON structured like this:
+
+ <span class="o">{</span>
+ <span class="s2">&quot;data&quot;</span>: <span class="o">[</span>
+ <span class="o">{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;match&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span>,
+ <span class="s2">&quot;attributes&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;createdAt&quot;</span>: <span class="s2">&quot;2017-01-06T20:30:08Z&quot;</span>,
+ <span class="s2">&quot;duration&quot;</span>: <span class="m">1482195372</span>,
+ <span class="s2">&quot;gameMode&quot;</span>: <span class="s2">&quot;casual&quot;</span>,
+ <span class="s2">&quot;patchVersion&quot;</span>: <span class="s2">&quot;1.0.0&quot;</span>,
+ <span class="s2">&quot;shardId&quot;</span>: <span class="s2">&quot;na&quot;</span>,
+ <span class="s2">&quot;stats&quot;</span>: <span class="s2">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="o">}</span>,
+ <span class="s2">&quot;relationships&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;rosters&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;data&quot;</span>: <span class="o">[{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;roster&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="o">}</span>, <span class="o">{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;roster&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="o">}]</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">]</span>
+<span class="o">}</span>
+</pre></div>
+</div>
+<p><strong>Java:</strong></p>
+<div class="highlight-java"><div class="highlight"><pre><span></span><span class="c1">//*There are a variety of Java HTTP libraries that support query-parameters.</span>
+
+<span class="c1">//The above command returns JSON structured like this:</span>
+
+<span class="o">{</span>
+ <span class="s">&quot;data&quot;</span><span class="o">:</span> <span class="o">[</span>
+ <span class="o">{</span>
+ <span class="s">&quot;type&quot;</span><span class="o">:</span> <span class="s">&quot;match&quot;</span><span class="o">,</span>
+ <span class="s">&quot;id&quot;</span><span class="o">:</span> <span class="s">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span><span class="o">,</span>
+ <span class="s">&quot;attributes&quot;</span><span class="o">:</span> <span class="o">{</span>
+ <span class="s">&quot;createdAt&quot;</span><span class="o">:</span> <span class="s">&quot;2017-01-06T20:30:08Z&quot;</span><span class="o">,</span>
+ <span class="s">&quot;duration&quot;</span><span class="o">:</span> <span class="mi">1482195372</span><span class="o">,</span>
+ <span class="s">&quot;gameMode&quot;</span><span class="o">:</span> <span class="s">&quot;casual&quot;</span><span class="o">,</span>
+ <span class="s">&quot;patchVersion&quot;</span><span class="o">:</span> <span class="s">&quot;1.0.0&quot;</span><span class="o">,</span>
+ <span class="s">&quot;shardId&quot;</span><span class="o">:</span> <span class="s">&quot;na&quot;</span><span class="o">,</span>
+ <span class="s">&quot;stats&quot;</span><span class="o">:</span> <span class="s">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="o">},</span>
+ <span class="s">&quot;relationships&quot;</span><span class="o">:</span> <span class="o">{</span>
+ <span class="s">&quot;rosters&quot;</span><span class="o">:</span> <span class="o">{</span>
+ <span class="s">&quot;data&quot;</span><span class="o">:</span> <span class="o">[{</span>
+ <span class="s">&quot;type&quot;</span><span class="o">:</span> <span class="s">&quot;roster&quot;</span><span class="o">,</span>
+ <span class="s">&quot;id&quot;</span><span class="o">:</span> <span class="s">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="o">},</span> <span class="o">{</span>
+ <span class="s">&quot;type&quot;</span><span class="o">:</span> <span class="s">&quot;roster&quot;</span><span class="o">,</span>
+ <span class="s">&quot;id&quot;</span><span class="o">:</span> <span class="s">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="o">}]</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">]</span>
+<span class="o">}</span>
+</pre></div>
+</div>
+<p><strong>Python:</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">requests</span>
+
+<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://api.dc01.gamelockerapp.com/shards/na/matches&quot;</span>
+
+<span class="n">header</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s2">&quot;Authorization&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;api-key&gt;&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;Accept&quot;</span><span class="p">:</span> <span class="s2">&quot;application/vnd.api+json&quot;</span>
+<span class="p">}</span>
+
+<span class="n">query</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s2">&quot;sort&quot;</span><span class="p">:</span> <span class="s2">&quot;createdAt&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;filter[playerNames]&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;playerName&gt;&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;filter[createdAt-start]&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-02-28T13:25:30Z&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;page[limit]&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span>
+<span class="p">}</span>
+
+<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">header</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">query</span><span class="p">)</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">&quot;data&quot;</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;match&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">&quot;createdAt&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-01-06T20:30:08Z&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;duration&quot;</span><span class="p">:</span> <span class="mi">1482195372</span><span class="p">,</span>
+ <span class="s2">&quot;gameMode&quot;</span><span class="p">:</span> <span class="s2">&quot;casual&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;patchVersion&quot;</span><span class="p">:</span> <span class="s2">&quot;1.0.0&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;shardId&quot;</span><span class="p">:</span> <span class="s2">&quot;na&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;stats&quot;</span><span class="p">:</span> <span class="s2">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="p">},</span>
+ <span class="s2">&quot;relationships&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">&quot;rosters&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">&quot;data&quot;</span><span class="p">:</span> <span class="p">[{</span>
+ <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="p">}]</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>Go:</strong></p>
+<div class="highlight-go"><div class="highlight"><pre><span></span><span class="nx">q</span> <span class="o">:=</span> <span class="nx">req</span><span class="p">.</span><span class="nx">URL</span><span class="p">.</span><span class="nx">Query</span><span class="p">()</span>
+<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">&quot;sort&quot;</span><span class="p">,</span> <span class="s">&quot;createdAt&quot;</span><span class="p">)</span>
+<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">&quot;filter[playerNames]&quot;</span><span class="p">,</span> <span class="s">&quot;&lt;playerName&gt;&quot;</span><span class="p">)</span>
+<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">&quot;filter[createdAt-start]&quot;</span><span class="p">,</span> <span class="s">&quot;2017-02-27T13:25:30Z&quot;</span><span class="p">)</span>
+<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">&quot;page[limit]&quot;</span><span class="p">,</span> <span class="s">&quot;3&quot;</span><span class="p">)</span>
+<span class="nx">req</span><span class="p">.</span><span class="nx">URL</span><span class="p">.</span><span class="nx">RawQuery</span> <span class="p">=</span> <span class="nx">q</span><span class="p">.</span><span class="nx">Encode</span><span class="p">()</span>
+<span class="nx">res</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">client</span><span class="p">.</span><span class="nx">Do</span><span class="p">(</span><span class="nx">req</span><span class="p">)</span>
+
+<span class="c1">//The above command returns JSON structured like this:</span>
+
+<span class="p">{</span>
+ <span class="s">&quot;data&quot;</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;match&quot;</span><span class="p">,</span>
+ <span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span><span class="p">,</span>
+ <span class="s">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">&quot;createdAt&quot;</span><span class="p">:</span> <span class="s">&quot;2017-01-06T20:30:08Z&quot;</span><span class="p">,</span>
+ <span class="s">&quot;duration&quot;</span><span class="p">:</span> <span class="mi">1482195372</span><span class="p">,</span>
+ <span class="s">&quot;gameMode&quot;</span><span class="p">:</span> <span class="s">&quot;casual&quot;</span><span class="p">,</span>
+ <span class="s">&quot;patchVersion&quot;</span><span class="p">:</span> <span class="s">&quot;1.0.0&quot;</span><span class="p">,</span>
+ <span class="s">&quot;shardId&quot;</span><span class="p">:</span> <span class="s">&quot;na&quot;</span><span class="p">,</span>
+ <span class="s">&quot;stats&quot;</span><span class="p">:</span> <span class="s">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="p">},</span>
+ <span class="s">&quot;relationships&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">&quot;rosters&quot;</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">&quot;data&quot;</span><span class="p">:</span> <span class="p">[{</span>
+ <span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="p">}]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="get-a-single-match">
+<h2>Get a Single Match<a class="headerlink" href="#get-a-single-match" title="Permalink to this headline">¶</a></h2>
+<p>This endpoint retrieves a specific match.</p>
+<p><strong>HTTP Request</strong>
+| <code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/shards/na/matches/&lt;ID&gt;</span></code></p>
+<p><strong>URL Parameters</strong>
+| Parameter: <code class="docutils literal"><span class="pre">ID</span></code>
+| Description: <code class="docutils literal"><span class="pre">The</span> <span class="pre">ID</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">match</span> <span class="pre">to</span> <span class="pre">retrieve</span></code></p>
+<p><strong>Shell:</strong></p>
+<div class="highlight-shell"><div class="highlight"><pre><span></span>curl <span class="s2">&quot;https://api.dc01.gamelockerapp.com/shards/na/matches/&lt;matchID&gt;&quot;</span> <span class="se">\</span>
+-H <span class="s2">&quot;Authorization: Bearer &lt;api-key&gt;&quot;</span> <span class="se">\</span>
+-H <span class="s2">&quot;Accept: application/vnd.api+json&quot;</span>
+
+ //The above <span class="nb">command</span> returns JSON structured like this:
+
+<span class="o">{</span>
+ <span class="s2">&quot;data&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;match&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span>,
+ <span class="s2">&quot;attributes&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;createdAt&quot;</span>: <span class="s2">&quot;2017-01-06T20:30:08Z&quot;</span>,
+ <span class="s2">&quot;duration&quot;</span>: <span class="m">1482195372</span>,
+ <span class="s2">&quot;gameMode&quot;</span>: <span class="s2">&quot;casual&quot;</span>,
+ <span class="s2">&quot;patchVersion&quot;</span>: <span class="s2">&quot;1.0.0&quot;</span>,
+ <span class="s2">&quot;shardId&quot;</span>: <span class="s2">&quot;na&quot;</span>,
+ <span class="s2">&quot;stats&quot;</span>: <span class="s2">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="o">}</span>,
+ <span class="s2">&quot;relationships&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;rosters&quot;</span>: <span class="o">{</span>
+ <span class="s2">&quot;data&quot;</span>: <span class="o">[{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;roster&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="o">}</span>, <span class="o">{</span>
+ <span class="s2">&quot;type&quot;</span>: <span class="s2">&quot;roster&quot;</span>,
+ <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="o">}]</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+<span class="o">}</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 URL parameters</span>
+
+ <span class="p">{</span>
+ <span class="s2">&quot;data&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;match&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;02b90214-c64d-11e6-9f6b-062445d3d668&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;attributes&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;createdAt&quot;</span><span class="o">:</span> <span class="s2">&quot;2017-01-06T20:30:08Z&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;duration&quot;</span><span class="o">:</span> <span class="mi">1482195372</span><span class="p">,</span>
+ <span class="s2">&quot;gameMode&quot;</span><span class="o">:</span> <span class="s2">&quot;casual&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;patchVersion&quot;</span><span class="o">:</span> <span class="s2">&quot;1.0.0&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;shardId&quot;</span><span class="o">:</span> <span class="s2">&quot;na&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;stats&quot;</span><span class="o">:</span> <span class="s2">&quot;acesEarned: 3, etc...&quot;</span>
+ <span class="p">},</span>
+ <span class="s2">&quot;relationships&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;rosters&quot;</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">&quot;data&quot;</span><span class="o">:</span> <span class="p">[{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;ea77c2eb-d44e-11e6-8f77-0242ac130004&quot;</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;roster&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;dc2c14b4-d50c-11e6-bf26-cec0c932ce01&quot;</span>
+ <span class="p">}]</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 current"><a class="current reference internal" href="#">Matches</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#rosters">Rosters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#participants">Participants</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#get-a-collection-of-matches">Get a Collection of Matches</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#get-a-single-match">Get a Single Match</a></li>
+</ul>
+</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"><a class="reference internal" href="../samples/samples.html">Samples</a></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>
+ &larr;
+ <a href="../receivingresponses/receivingresponses.html" title="Previous document">Receiving Responses</a>
+ </li>
+ <li>
+ <a href="../match_data_summary/match_data_summary.html" title="Next document">Match Data Summary</a>
+ &rarr;
+ </li>
+ </ul>
+ </nav>
+ <nav id="breadcrumbs">
+ <ul>
+ <li><a href="../index.html">Battelrite 0.2 documentation</a></li>
+ </ul>
+ </nav>
+ </div>
+
+ </body>
+</html> \ No newline at end of file