https://dev.afsanalytics.com/docs/api/reference/

1
2<!doctype html>
3<html lang="en" class="no-js">
4  <head>
5    
6      <meta charset="utf-8">
7      <meta name="viewport" content="width=device-width,initial-scale=1">
8      
9        <meta name="description" content="AFS Analytics API Reference.">
10      
11      
12      
13        <link rel="canonical" href="https://dev.afsanalytics.com/api/reference/">
14      
15      
16        <link rel="prev" href="../introduction/">
17      
18      
19        <link rel="next" href="../sdk/introduction/">
20      
21      
22      <link rel="icon" href="../../assets/images/favicon.png">
23      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
24    
25    
26      
27        <title>AFS Analytics API Reference - AFSAnalytics.com</title>
28      
29    
30    
31      <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.min.css">
32      
33      
34
35
36    
37    
38      
39    
40    
41      
42        
43        
44        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
45        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
46        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
47      
48    
49    
50      <link rel="stylesheet" href="../../css/custom.css">
51    
52      <link rel="stylesheet" href="../../css/native.css">
53    
54    

54<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

54
55    
56      
57
58    
59    
60    
61<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui.css">

62<script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script>

62

63<script>
64    window.onload = function () {
65
66        if (typeof SwaggerUIBundle !== 'undefined ')
67        {
68            var ui = SwaggerUIBundle({
69                url: `/assets/openapi/v1/afsa.json`,
70                dom_id: '#swagger-ui',
71                presets: [
72                    SwaggerUIBundle.presets.apis,
73                    SwaggerUIBundle.SwaggerUIStandalonePreset
74                ]
75            });
76        }
77
78    };
79</script>

79
80
81  </head>
82  
83  
84    <body dir="ltr">
85  
86    
87    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
88    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
89    <label class="md-overlay" for="__drawer"></label>
90    <div data-md-component="skip">
91      
92        
93        <a href="#afs-analytics-api-reference" class="md-skip">
94          Skip to content
95        </a>
96      
97    </div>
98    <div data-md-component="announce">
99      
100    </div>
101    
102    
103
104
105
106
107<header class="md-header md-header--shadow" data-md-component="header">
108  <nav class="md-header__inner md-grid" aria-label="Header">
109    <a href="../.." title="AFSAnalytics.com"
110      class="md-header__button md-logo" aria-label="AFSAnalytics.com" data-md-component="logo">
111      <img src="../../assets/images/logo.white.png">
112    </a>
113    <label class="md-header__button md-icon" for="__drawer">
114      
115      <!-- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> -->
116    </label>
117    <div class="md-header__title" data-md-component="header-title">
118      <div class="md-header__ellipsis">
119        <div class="md-header__topic">
120          <span class="md-ellipsis">
121            AFSAnalytics.com
122          </span>
123        </div>
124        <div class="md-header__topic" data-md-component="header-topic">
125          <span class="md-ellipsis">
126            
127            AFS Analytics API Reference
128            
129          </span>
130        </div>
131      </div>
132    </div>
133    
134    
135    

135<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>

135
136    
137    
138    
139    <label class="md-header__button md-icon" for="__search">
140      
141      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
142    </label>
143    <div class="md-search" data-md-component="search" role="dialog">
144    <label class="md-search__overlay" for="__search"></label>
145    <div class="md-search__inner" role="search">
146        <form class="md-search__form" name="search">
147            <input type="text" class="md-search__input" name="query" aria-label="Search"
148                placeholder="Search" autocapitalize="off" autocorrect="off"
149                autocomplete="off" spellcheck="false" data-md-component="search-query" required>
150            <label class="md-search__icon md-icon" for="__search">
151                
152                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
153                
154                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
155            </label>
156            <nav class="md-search__options" aria-label="Search">
157                
158                <button type="reset" class="md-search__icon md-icon" title="Clear"
159                    aria-label="Clear" tabindex="-1">
160                    
161                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
162                </button>
163            </nav>
164            
165        </form>
166        <div class="md-search__output">
167            <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
168                <div class="md-search-result" data-md-component="search-result">
169                    <div class="md-search-result__meta">
170                        Initializing search
171                    </div>
172                    <ol class="md-search-result__list" role="presentation"></ol>
173                </div>
174            </div>
175        </div>
176    </div>
177</div>
178    
179    
180  </nav>
181  
182</header>
183
184    <div class="md-container" data-md-component="container">
185      
186      
187        
188          
189        
190      
191      <main class="md-main" data-md-component="main">
192        <div class="md-main__inner md-grid">
193          
194            
195              
196              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
197                <div class="md-sidebar__scrollwrap">
198                  <div class="md-sidebar__inner">
199                    
200
201
202
203
204
205<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
206
207    <!-- Site title -->
208    <label class="md-nav__title md-nav__title--site" for="__drawer">
209        <a href="/" title="AFS Analytics for developers" class="afsa_nav_title">
210    
211            
212            AFS Analytics for developers
213            
214    
215        </a>
216    </label>
217
218
219    <!-- <label class="md-nav__title" for="__drawer">
220        <a href="../.." title="AFSAnalytics.com"
221            class="md-nav__button md-logo" aria-label="AFSAnalytics.com" data-md-component="logo">
222            <img src="../../assets/images/logo.white.png">
223        </a>
224        AFSAnalytics.com
225    </label> -->
226    
227    <ul class="md-nav__list" data-md-scrollfix>
228        
229        
230        
231  
232  
233  
234  
235    <li class="md-nav__item">
236      <a href="../.." class="md-nav__link">
237        
238  
239  <span class="md-ellipsis">
240    About
241  </span>
242  
243
244      </a>
245    </li>
246  
247
248        
249        
250        
251  
252  
253    
254  
255  
256  
257    
258    
259    
260    
261    <li class="md-nav__item md-nav__item--active md-nav__item--nested">
262      
263        
264        
265        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
266        
267          
268          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
269            
270  
271  <span class="md-ellipsis">
272    API
273  </span>
274  
275

276            <span class="md-nav__icon md-icon"></span>
277          </label>
278        
279        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
280          <label class="md-nav__title" for="__nav_2">
281            <span class="md-nav__icon md-icon"></span>
282            API
283          </label>
284          <ul class="md-nav__list" data-md-scrollfix>
285            
286              
287                
288  
289  
290  
291  
292    <li class="md-nav__item">
293      <a href="../introduction/" class="md-nav__link">
294        
295  
296  <span class="md-ellipsis">
297    Introduction
298  </span>
299  
300
301      </a>
302    </li>
303  
304
305              
306            
307              
308                
309  
310  
311    
312  
313  
314  
315    <li class="md-nav__item md-nav__item--active">
316      
317      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
318      
319      
320        
321      
322      
323        <label class="md-nav__link md-nav__link--active" for="__toc">
324          
325  
326  <span class="md-ellipsis">
327    Reference
328  </span>
329  
330
331          <span class="md-nav__icon md-icon"></span>
332        </label>
333      
334      <a href="./" class="md-nav__link md-nav__link--active">
335        
336  
337  <span class="md-ellipsis">
338    Reference
339  </span>
340  
341
342      </a>
343      
344        
345
346<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
347  
348  
349  
350    
351  
352  
353    <label class="md-nav__title" for="__toc">
354      <span class="md-nav__icon md-icon"></span>
355      Table of contents
356    </label>
357    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
358      
359        <li class="md-nav__item">
360  <a href="#testing-the-api" class="md-nav__link">
361    <span class="md-ellipsis">
362      Testing the API
363    </span>
364  </a>
365  
366</li>
367      
368        <li class="md-nav__item">
369  <a href="#reference" class="md-nav__link">
370    <span class="md-ellipsis">
371      Reference
372    </span>
373  </a>
374  
375</li>
376      
377    </ul>
378  
379</nav>
380      
381    </li>
382  
383
384              
385            
386              
387                
388  
389  
390  
391  
392    <li class="md-nav__item">
393      <a href="../sdk/introduction/" class="md-nav__link">
394        
395  
396  <span class="md-ellipsis">
397    SDK
398  </span>
399  
400
401      </a>
402    </li>
403  
404
405              
406            
407          </ul>
408        </nav>
409      
410    </li>
411  
412
413        
414    </ul>
415</nav>
416                  </div>
417                </div>
418              </div>
419            
420            
421              
422              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
423                <div class="md-sidebar__scrollwrap">
424                  <div class="md-sidebar__inner">
425                    
426
427<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
428  
429  
430  
431    
432  
433  
434    <label class="md-nav__title" for="__toc">
435      <span class="md-nav__icon md-icon"></span>
436      Table of contents
437    </label>
438    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
439      
440        <li class="md-nav__item">
441  <a href="#testing-the-api" class="md-nav__link">
442    <span class="md-ellipsis">
443      Testing the API
444    </span>
445  </a>
446  
447</li>
448      
449        <li class="md-nav__item">
450  <a href="#reference" class="md-nav__link">
451    <span class="md-ellipsis">
452      Reference
453    </span>
454  </a>
455  
456</li>
457      
458    </ul>
459  
460</nav>
461                  </div>
462                </div>
463              </div>
464            
465          
466          
467            <div class="md-content" data-md-component="content">
468              <article class="md-content__inner md-typeset">
469                
470                  
471
472  
473  
474
475
476<h1 id="afs-analytics-api-reference">AFS Analytics API Reference<a class="headerlink" href="#afs-analytics-api-reference" title="Permanent link">&para;</a></h1>
477<h2 id="testing-the-api">Testing the API<a class="headerlink" href="#testing-the-api" title="Permanent link">&para;</a></h2>
478<p>You can test any of the referenced API call. To do so 
479you will need to use our <strong>Demo API Key</strong>:</p>
480<ol>
481<li>click on the <em>Authorize</em> button below </li>
482<li>enter the key <mark>3-hADe4a5u3u2e2yHyzUVyzYXEJeBY7umU</mark> in the "Value" field</li>
483<li>select <em>Authorize</em></li>
484</ol>
485<div class="admonition tip">
486<p class="admonition-title">Tip</p>
487<p>Test our API with your own account by creating an <a href="https://dev.afsanalytics.com/manage/api/keys">API Access Key</a>.</p>
488</div>
489<h2 id="reference">Reference<a class="headerlink" href="#reference" title="Permanent link">&para;</a></h2>
490<div id="swagger-ui"></div>
491
492
493
494
495
496
497
498  
499    
500  
501  
502
503
504  <aside class="md-source-file">
505    
506      
507  <span class="md-source-file__fact">
508    <span class="md-icon" title="Last update">
509      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">

509<path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
510    </span>
511    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">April 8, 2020 17:30:43</span>
512  </span>
513
514    
515    
516    
517    
518  </aside>
519
520
521
522
523
524                
525              </article>
526            </div>
527          
528          

529<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

529
530        </div>
531        
532      </main>
533      
534
535<footer class="md-footer">
536    
537    <div class="md-footer-meta md-typeset">
538        <div class="md-footer-meta__inner md-grid">
539            <div class="md-copyright">
540    
541    <div class="md-copyright__highlight">
542        © AFS Analytics.com 2024
543    </div>
544    
545    
546</div>
547            
548        </div>
549    </div>
550
551
552</footer>
553
554 
555<!-- Start AFS Analytics - Web Analytics 7.0 -->

556<script type="text/javascript">(function (i, s, o, g, r, a, m) { i['AfsAnalyticsObject'] = r; i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments) }, i[r].l = 1 * new Date(); a = s.createElement(o), m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) })(window, document, 'script', '//code.afsanalytics.com/js2/analytics.js', 'aa');
557    aa("create", "00000001", "auto");
558    aa("set", "cookieconsent_mode", "consent");
559    aa("set", "cookieconsent_audience", "eu");
560    aa("set", "cookieconsent_callback", "askconsent");
561    aa("set", "autotrack", "dataset");
562    
563    aa("send", "pageview", "titleindex", "AFS Analytics API Reference");
564    
565</script>

565
566<!-- End AFS Analytics -->
567
568    </div>
569    <div class="md-dialog" data-md-component="dialog">
570      <div class="md-dialog__inner md-typeset"></div>
571    </div>
572    
573    
574    

574<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

574
575    
576    
577      

577<script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>

577
578      
579    
580  </body>
581</html>