CINXE.COM

<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Reports API | Text Platform Docs & API Reference</title><link rel="canonical" href="https://platform.text.com/docs/data-reporting/reports-api"/><link rel="preconnect" href="https://LATDYRDX9J-dsn.algolia.net" crossorigin="true"/><meta name="description" content="See how you can access and extract data from Reports with the use of Reports API."/><meta property="og:title" content="Reports API"/><meta property="og:description" content="See how you can access and extract data from Reports with the use of Reports API."/><meta property="og:type" content="website"/><meta property="og:image" content="https://platform.text.com/docs/images/text-docs-og.png"/><link rel="icon" href="/docs/images/favicon.ico"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@textplatform"/><meta name="twitter:title" content="Reports API"/><meta name="twitter:description" content="See how you can access and extract data from Reports with the use of Reports API."/><meta name="twitter:image" content="https://platform.text.com/docs/images/livechat-docs-og.png"/><script type="text/javascript"> window.__lc = window.__lc || {}; window.__lc.license = 1520; ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/staging/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice)) </script><meta name="next-head-count" content="17"/><link rel="preload" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/data-reporting/reports-api-dd0bc2859bdc4d3aad93.js" as="script"/> <script>!function(e){var n="https://s.go-mpulse.net/boomerang/";if("False"=="True")e.BOOMR_config=e.BOOMR_config||{},e.BOOMR_config.PageParams=e.BOOMR_config.PageParams||{},e.BOOMR_config.PageParams.pci=!0,n="https://s2.go-mpulse.net/boomerang/";if(window.BOOMR_API_key="SWHJY-Y2PHV-NVPM2-PDH42-VMPQS",function(){function e(){if(!o){var e=document.createElement("script");e.id="boomr-scr-as",e.src=window.BOOMR.url,e.async=!0,i.parentNode.appendChild(e),o=!0}}function t(e){o=!0;var n,t,a,r,d=document,O=window;if(window.BOOMR.snippetMethod=e?"if":"i",t=function(e,n){var t=d.createElement("script");t.id=n||"boomr-if-as",t.src=window.BOOMR.url,BOOMR_lstart=(new Date).getTime(),e=e||d.body,e.appendChild(t)},!window.addEventListener&&window.attachEvent&&navigator.userAgent.match(/MSIE [67]\./))return window.BOOMR.snippetMethod="s",void t(i.parentNode,"boomr-async");a=document.createElement("IFRAME"),a.src="about:blank",a.title="",a.role="presentation",a.loading="eager",r=(a.frameElement||a).style,r.width=0,r.height=0,r.border=0,r.display="none",i.parentNode.appendChild(a);try{O=a.contentWindow,d=O.document.open()}catch(_){n=document.domain,a.src="javascript:var d=document.open();d.domain='"+n+"';void(0);",O=a.contentWindow,d=O.document.open()}if(n)d._boomrl=function(){this.domain=n,t()},d.write("<bo"+"dy onload='document._boomrl();'>");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"SWHJY-Y2PHV-NVPM2-PDH42-VMPQS";var i=document.currentScript||document.getElementsByTagName("script")[0],o=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!o)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),i.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="bdpnbet4tppjwz2b5rgq-f-c8f7861b9-clientnsv4-s.akamaihd.net",i="false"=="true"?2:1,o={"ak.v":"39","ak.cp":"1461330","ak.ai":parseInt("908031",10),"ak.ol":"0","ak.cr":0,"ak.ipv":4,"ak.proto":"http/1.1","ak.rid":"e1e2c1d","ak.r":6099,"ak.a2":n,"ak.m":"b","ak.n":"essl","ak.bpcip":"8.222.208.0","ak.cport":37414,"ak.gh":"124.155.222.130","ak.quicv":"","ak.tlsv":"tls1.2","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"reno","ak.t":"1732373581","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==XAQucnSCTBXCw/lkimq46+0eQdmAfKhyRrmzKps2aOmxW81L4uEAG2GluHgHBk3/ekATME1/yIqHbvFP725wyf2brB2urvmPBOLkNgYKrD0MRSqPeaC3+2OSw1hX4nnnLo2bJ6KjfeC7VjJ9JgyGx+SUUGPr2pOpBNE1RnzfEx2Lbyw770rIA+1+dwZnj0IASodiNWdtNicSS6VfhvT0r6pbb0WaAXB+qE3O9yHIZ/ioNToLXXvCcOlamg6QzbbZD4/Ai+HRwIXVHvKJwzoIeYlCpauW5sYdbM628/PLJKNzowp76ci1XsREO0lpI98DehK1cJH5c71MWpRSoMWi14a76O5NlBD/a6nlL4vYuwGJaBeByHE9VSd99Nru11cq2gHKv45waGNmH6FAyLqvKJR2HHjl2LvEvlKJhvkJh5M=","ak.pv":"55","ak.dpoabenc":"","ak.tf":i};if(""!==t)o["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))o["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(o)},rv:function(){var e=["ak.bpcip","ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:o,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);</script></head><body><div id="__next"><style data-emotion-css="cvn8wj">.css-cvn8wj{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;background-color:#4a4a55;height:60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;position:fixed;top:0;width:100%;z-index:99;}@media (min-width:768px){.css-cvn8wj{height:60px;}}</style><div class="css-cvn8wj"><style data-emotion-css="y9662z">.css-y9662z{background:#4a4a55;width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;}</style><div class="css-y9662z"><style data-emotion-css="qqcdow">.css-qqcdow{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;font-size:15px;margin:0 20px;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:60px;}.css-qqcdow > a > svg{margin:0;display:block;height:24px;}</style><nav class="css-qqcdow"><style data-emotion-css="c2yzgf">.css-c2yzgf{color:white;-webkit-text-decoration:none;text-decoration:none;font-weight:500;white-space:nowrap;margin-left:8px;}.css-c2yzgf:hover{-webkit-text-decoration:none;text-decoration:none;color:white;}</style><a href="https://text.com/" class="css-c2yzgf"><style data-emotion-css="ofqsza">.css-ofqsza{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;justify-items:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:0.8em;height:40px;}.css-ofqsza .logo{margin:0;font-size:2em;font-weight:500;-webkit-letter-spacing:-0.01em;-moz-letter-spacing:-0.01em;-ms-letter-spacing:-0.01em;letter-spacing:-0.01em;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-ofqsza .adjacent{margin:0;font-size:1.8em;font-weight:500;line-height:34px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-letter-spacing:-0.5px;-moz-letter-spacing:-0.5px;-ms-letter-spacing:-0.5px;letter-spacing:-0.5px;}.css-ofqsza .carrier{font-weight:500;-webkit-animation-name:blink;animation-name:blink;-webkit-animation-duration:0.9s;animation-duration:0.9s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;}</style><header class="css-ofqsza"><span class="logo">text<span class="carrier">|</span></span></header></a><a href="/docs" class="css-c2yzgf">Platform Docs</a></nav><style data-emotion-css="16b59id">.css-16b59id{margin:0;padding:0;max-width:calc(100% - 60px);width:calc(100% - 60px);overflow-x:auto;overflow-y:hidden;display:none;margin-right:10px;margin-left:40px;}@media (min-width:1024px){.css-16b59id{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;gap:32px;}}</style><div class="css-16b59id"><style data-emotion-css="11hjr56">.css-11hjr56{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;position:relative;display:inline-block;height:100%;color:#ffffff;font-weight:400;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-11hjr56:hover{cursor:default;}</style><div class="css-11hjr56">Platform<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">APIs & SDKs<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">Resources<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div><style data-emotion-css="1hppjzv">.css-1hppjzv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1hppjzv"><style data-emotion-css="7wgbw1">.css-7wgbw1{display:none;}@media (min-width:1024px){.css-7wgbw1{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;width:192px;margin-right:16px;}}</style><div class="DocSearch-Button-Desktop css-7wgbw1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><style data-emotion-css="1i8rrts">.css-1i8rrts{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:100%;}@media (min-width:1024px){.css-1i8rrts{display:none;}}</style><div class="DocSearch-Button-Mobile css-1i8rrts"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><p>...</p><style data-emotion-css="pskeb7">@media (min-width:1024px){.css-pskeb7{display:none;}}</style><style data-emotion-css="19rp0xe">.css-19rp0xe{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin-right:16px;cursor:pointer;}@media (min-width:1024px){.css-19rp0xe{display:none;}}@media (min-width:1024px){.css-19rp0xe{display:none;}}</style><svg width="32px" height="28px" fill="#ffffff" class="rmi rmi-menu css-19rp0xe" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg></div></div></div><style data-emotion-css="ov1ktg">.css-ov1ktg{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}</style><div class="css-ov1ktg"><style data-emotion-css="hpx2k5">.css-hpx2k5{border-right:1px solid #e2e2e4;height:50px;position:fixed;-webkit-transition:height 300ms;transition:height 300ms;display:block;bottom:0%;width:100%;opacity:1;z-index:10;box-shadow:0px 0px 8px rgba(0,0,0,0.25);background-color:white;}@media (min-width:768px){.css-hpx2k5{box-shadow:none;height:100vh;max-height:100vh;position:-webkit-sticky;position:sticky;top:60px;-webkit-transition:all 0s;transition:all 0s;width:260px;}}</style><aside class="css-hpx2k5"><style data-emotion-css="y8dejn">.css-y8dejn{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;background-color:white;padding:10px 14px;cursor:pointer;}@media (min-width:768px){.css-y8dejn{display:none;}}</style><div class="css-y8dejn"><svg style="transform:rotate(270deg);transition:transform 300ms" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z" fill="currentColor"></path><path d="M0 0h24v24H0z" fill="none"></path></svg>Reports API</div><style data-emotion-css="v8mm6">.css-v8mm6{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}@media (min-width:768px){.css-v8mm6{display:none;}}</style><div class="css-v8mm6"><style data-emotion-css="1pjh3pd">.css-1pjh3pd{width:100%;color:#62626D;}.css-1pjh3pd:hover{cursor:pointer;-webkit-text-decoration:none;text-decoration:none;background-color:#f6f6f7;}</style><a class="css-1pjh3pd"><style data-emotion-css="1yw2pv4">.css-1yw2pv4{padding:4px 14px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;font-size:16px;}</style><div class="css-1yw2pv4"><style data-emotion-css="5c7uuc">.css-5c7uuc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:start;-ms-flex-pack:start;justify-content:start;}</style><div class="css-5c7uuc"><svg width="24" height="20px" fill="#62626D" class="rmi rmi-home undefined" viewBox="0 0 24 24"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8h5z"></path></svg></div>Home</div></a></div><style data-emotion-css="1ln71vl">.css-1ln71vl{overflow:scroll;height:calc(100% - 90px);}@media (min-width:768px){.css-1ln71vl{height:calc(100% - 60px);position:fixed;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;height:100%;max-height:100vh;position:-webkit-sticky;position:-webkit-sticky;position:sticky;top:0;margin-top:8px;}}</style><div class="css-1ln71vl"><style data-emotion-css="1psvkz3">.css-1psvkz3{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1psvkz3:hover{background-color:#f6f6f7;}</style><div class="css-1psvkz3"><style data-emotion-css="19nl305">.css-19nl305{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#62626D;width:100%;}.css-19nl305:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-19nl305"><style data-emotion-css="2hhlpj">.css-2hhlpj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 20px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-2hhlpj:hover{background-color:#f6f6f7;}</style><div class="css-2hhlpj"><style data-emotion-css="oe3dsw">.css-oe3dsw{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;margin-right:8px;}</style><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Reporting Overview</div></a></div><style data-emotion-css="1gg9bms">.css-1gg9bms{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:600;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1gg9bms:hover{background-color:#f6f6f7;}</style><div class="css-1gg9bms"><style data-emotion-css="17iyluq">.css-17iyluq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#4284F5;width:100%;}.css-17iyluq:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-17iyluq"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Reports API</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Changelog</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>App monitoring</div></a></div></div></aside><style data-emotion-css="1g06r20">.css-1g06r20{padding-bottom:30vh;position:relative;width:100%;}@media (min-width:768px){.css-1g06r20{width:calc(100% - 258px);max-width:900px;}}</style><div class="css-1g06r20"><style data-emotion-css="yofbie">.css-yofbie{width:100%;position:fixed;top:60px;right:0;z-index:40;-webkit-transition:left 0.3s ease-out;transition:left 0.3s ease-out;}@media (min-width:768px){.css-yofbie{left:260px;width:calc(100% - 260px);top:60px;}}</style><div class="css-yofbie"><style data-emotion-css="9hc061">.css-9hc061{padding:20px 24px 32px 60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:10px;}@media (max-width:1270px){.css-9hc061{background-color:#fff;padding-bottom:24px;}}@media (max-width:768px){.css-9hc061{-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;padding-left:30px;}}</style><div class="css-9hc061"><style data-emotion-css="7fagxn">.css-7fagxn{font-weight:400;font-size:15px;line-height:22px;padding:7px 8px 7px 16px;}</style><button class="lc-btn lc-btn--secondary css-7fagxn" type="button"><div><style data-emotion-css="44gx6g">.css-44gx6g{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:4px;}</style><div class="css-44gx6g"><span>API version:</span><span>3.5 (stable)</span><svg width="20px" height="20px" fill="#424D57" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div></button></div></div><style data-emotion-css="c8i9h7">.css-c8i9h7{margin-top:120px;padding:0px 30px;}@media (min-width:768px){.css-c8i9h7{padding:0px 60px;}}.css-c8i9h7.redoc{margin-top:60px;display:block;}</style><article class=" css-c8i9h7"><style data-emotion-css="1lyzzun">.css-1lyzzun{margin:3em 0 1em;padding:2em 0 1em;}</style><div class="css-1lyzzun"><style data-emotion-css="12qxxrf">.css-12qxxrf{margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;font-weight:500;text-rendering:optimizeLegibility;font-size:2.25rem;line-height:1.1;-webkit-letter-spacing:-0.02em;-moz-letter-spacing:-0.02em;-ms-letter-spacing:-0.02em;letter-spacing:-0.02em;}@media (min-width:768px){.css-12qxxrf{-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}}</style><h2 id="reports-api" class="css-12qxxrf"><span>Reports API</span><style data-emotion-css="1g0dr3m">.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}</style></h2></div><style data-emotion-css="1679d3t">.css-1679d3t{border-bottom:1px solid #e0e4e9;padding-bottom:0.5em;}</style><h2 class="heading css-1679d3t"><style data-emotion-css="180507a">.css-180507a{color:inherit;-webkit-text-decoration:none;text-decoration:none;position:relative;}.css-180507a:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-180507a:hover:before{content:"#";position:absolute;font-weight:300;left:-1em;top:1px;opacity:0.3;}.css-180507a:focus-visible{outline-width:0px;}</style><a id="introduction" href="#introduction" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#introduction"><span class="icon icon-link"></span></a>Introduction</a></h2><p>Reports API allows you to <strong>access</strong> and <strong>extract</strong> all the <a href="https://www.livechat.com/kb/reporting-options-available-in-livechat/">Reports</a> data available in LiveChat.</p><h3 class="heading"><a id="versioning" href="#versioning" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#versioning"><span class="icon icon-link"></span></a>Versioning</a></h3><p>This document describes the <strong>LiveChat Reports API v3.5</strong>. This is the latest stable version recommended for the production use. <a href="/docs/management#api-versioning">Read more about versioning...</a></p><h3 class="heading"><a id="authorization" href="#authorization" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#authorization"><span class="icon icon-link"></span></a>Authorization</a></h3><p>You can authorize your calls to the Reports API using one of the following methods:</p><ul><li><a href="/docs/authorization/authorizing-api-calls#implicit-grant">Bearer Token</a></li><li><a href="/docs/authorization/agent-authorization#personal-access-tokens">Basic Auth (Personal Access Tokens)</a></li></ul><h3 class="heading"><a id="postman-collection" href="#postman-collection" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#postman-collection"><span class="icon icon-link"></span></a>Postman collection</a></h3><p>You can find all the requests from the Reports API v3.5 in Postman. In our collection, we use <a href="https://learning.getpostman.com/docs/postman/environments_and_globals/manage_environments/">environment variables</a> that store, for example, the access token. Importing the collection from the link below downloads the environment as well. Remember to replace sample tokens with your own.</p><p><a href="https://god.gw.postman.com/run-collection/20754404-8f462c2b-98cb-4d84-a329-55f87d930886?action=collection%2Ffork&collection-url=entityId%3D20754404-8f462c2b-98cb-4d84-a329-55f87d930886%26entityType%3Dcollection%26workspaceId%3D5e6fb31b-587b-4258-b215-4dccaae38a38#?env%5BLiveChat%20APIs%5D=W3sia2V5IjoiZGF0ZV9mcm9tIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJkYXRlX3RvIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJhZ2VudCIsInZhbHVlIjoiam9obi5kb2VAbXljb21wYW55LmNvbSIsImVuYWJsZWQiOnRydWUsInNlc3Npb25WYWx1ZSI6ImpvaG4uZG9lQG15Y29tcGFueS5jb20iLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiZ3JvdXBfYnkiLCJ2YWx1ZSI6ImhvdXIiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJob3VyIiwic2Vzc2lvbkluZGV4IjozfSx7ImtleSI6Imdyb3VwIiwidmFsdWUiOiIyIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJ3ZWVrZGF5IiwidmFsdWUiOiJtb24iLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJtb24iLCJzZXNzaW9uSW5kZXgiOjV9LHsia2V5IjoiYXBpX3ZlcnNpb24iLCJ2YWx1ZSI6InYzLjUiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJ2My41Iiwic2Vzc2lvbkluZGV4Ijo2fSx7ImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwic2Vzc2lvbkluZGV4Ijo3fSx7ImtleSI6ImN1c3RvbWVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfcHE3UVllVlpMRkV6RE5CVGciLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJkYWw6dGVzdF9wcTdRWWVWWkxGRXpETkJUZyIsInNlc3Npb25JbmRleCI6OH0seyJrZXkiOiJhY2NvdW50X2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJzZXNzaW9uSW5kZXgiOjl9LHsia2V5IjoibGljZW5zZV9pZCIsInZhbHVlIjoiMTA0MTMwNjIzIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMTA0MTMwNjIzIiwic2Vzc2lvbkluZGV4IjoxMH0seyJrZXkiOiJwYXJ0bmVyX2FwaV91cmwiLCJ2YWx1ZSI6Imh0dHBzOi8vYXBpLmxpdmVjaGF0aW5jLmNvbS92Mi9wYXJ0bmVycyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGkubGl2ZWNoYXRpbmMuY29tL3YyL3BhcnRuZXJzIiwic2Vzc2lvbkluZGV4IjoxMX0seyJrZXkiOiJwYXJ0bmVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsInNlc3Npb25JbmRleCI6MTJ9LHsia2V5Ijoib3JnYW5pemF0aW9uX2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGxqLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6ImI3ZWZmNzk4LWY4bGotNDM2NC04MDU5LTY0OWMzNWM5ZWQwYyIsInNlc3Npb25JbmRleCI6MTN9XQ=="><div style="max-width:123px"><style data-emotion-css="v3memn">.css-v3memn{display:block;max-width:100%;overflow:hidden;position:relative;box-sizing:border-box;margin-top:0;margin-left:0;margin-right:0;margin-bottom:10px;}</style><div class="css-v3memn"><style data-emotion-css="sa8835">.css-sa8835{box-sizing:border-box;display:block;max-width:100%;padding-top:calc(30 / 123 * 100%);}</style><div class="css-sa8835"><style data-emotion-css="5r33xa">.css-5r33xa{position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%;}</style><img alt="Run in Postman" src="https://run.pstmn.io/button.svg" decoding="async" class="css-5r33xa"/></div></div></div></a></p><h2 class="heading css-1679d3t"><a id="methods" href="#methods" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#methods"><span class="icon icon-link"></span></a>Methods</a></h2><style data-emotion-css="v24v0q">.css-v24v0q{max-width:830px;}</style><section class="css-v24v0q"><style data-emotion-css="q76ucn">.css-q76ucn{width:100%;overflow-x:auto;}</style><div class="css-q76ucn"><table><thead><tr><th>The API endpoint</th></tr></thead><tbody><tr><td><code>https://api.livechatinc.com/v3.5/reports/<resource>/<action></code></td></tr></tbody></table></div></section><h3 class="heading"><a id="headers" href="#headers" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#headers"><span class="icon icon-link"></span></a>Headers</a></h3><p><strong>Common headers for all methods:</strong></p><div class="css-q76ucn"><table><thead><tr><th>Header</th><th>Value</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>Authorization</code></td><td><code>Bearer <token></code></td><td>Yes</td><td>Your access token</td></tr><tr><td><code>X-API-Version</code></td><td><code>3.5</code></td><td>No</td><td>The API version. You can also specify it in the URL.</td></tr></tbody></table></div><p><strong>Additional headers specifically for the POST methods:</strong></p><div class="css-q76ucn"><table><thead><tr><th>Header</th><th>Value</th><th>Required</th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td><code>application/json</code></td><td>Yes</td></tr></tbody></table></div><section class="css-v24v0q"><style data-emotion-css="11ycufd">.css-11ycufd{-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;max-width:100%;overflow-x:auto;}</style><div class="css-11ycufd"><h3 class="heading"><a id="available-methods" href="#available-methods" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#available-methods"><span class="icon icon-link"></span></a>Available methods</a></h3><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Chats</strong></td><td><style data-emotion-css="kbi7q3">.css-kbi7q3{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3 svg{vertical-align:middle;margin-left:2px;margin-right:4px;color:#4284F5;}.css-kbi7q3 code{color:#4284F5;}.css-kbi7q3:hover,.css-kbi7q3:active{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3:hover code,.css-kbi7q3:active code{color:#4284F5;-webkit-text-decoration:underline;text-decoration:underline;}</style><a href="/docs/data-reporting/reports-api#duration" class="css-kbi7q3"><code>duration</code></a> <a href="/docs/data-reporting/reports-api#tags" class="css-kbi7q3"><code>tags</code></a> <a href="/docs/data-reporting/reports-api#total-chats" class="css-kbi7q3"><code>total_chats</code></a> <a href="/docs/data-reporting/reports-api#ratings" class="css-kbi7q3"><code>ratings</code></a> <a href="/docs/data-reporting/reports-api#ranking" class="css-kbi7q3"><code>ranking</code></a> <a href="/docs/data-reporting/reports-api#engagement" class="css-kbi7q3"><code>engagement</code></a> <a href="/docs/data-reporting/reports-api#greetings-conversion" class="css-kbi7q3"><code>greetings_conversion</code></a> <a href="/docs/data-reporting/reports-api#forms" class="css-kbi7q3"><code>forms</code></a> <a href="/docs/data-reporting/reports-api#response-time" class="css-kbi7q3"><code>response_time</code></a> <a href="/docs/data-reporting/reports-api#first-response-time" class="css-kbi7q3"><code>first_response_time</code></a></td></tr><tr><td><strong>Agents</strong></td><td><a href="/docs/data-reporting/reports-api#availability" class="css-kbi7q3"><code>availability</code></a> <a href="/docs/data-reporting/reports-api#performance" class="css-kbi7q3"><code>performance</code></a></td></tr><tr><td><strong>Tags</strong></td><td><a href="/docs/data-reporting/reports-api#chat-usage" class="css-kbi7q3"><code>chat_usage</code></a></td></tr></tbody></table></div><h3 class="heading"><a id="available-parameters-and-filters" href="#available-parameters-and-filters" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#available-parameters-and-filters"><span class="icon icon-link"></span></a>Available parameters and filters</a></h3><h4 class="heading"><a id="for-the-chats-reports" href="#for-the-chats-reports" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#for-the-chats-reports"><span class="icon icon-link"></span></a>For the Chats reports</a></h4><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>distribution</code></td><td>No</td><td><code>string</code></td><td>Allowed values: <code>hour</code>, <code>day</code>, <code>day-hours</code>, <code>month</code> or <code>year</code>. Defaults to <code>day</code>.</td></tr><tr><td><code>timezone</code></td><td>No</td><td><code>string</code></td><td>IANA <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a> (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, <code>filters.from</code> is parsed to get it.</td></tr><tr><td><code>filters</code></td><td>No</td><td><code>object</code></td><td>If none provided, your report will span the last seven days.</td></tr><tr><td><code>filters.from</code></td><td>No</td><td><code>string</code></td><td>Filters out chats that took place within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.to</code></td><td>No</td><td><code>string</code></td><td>Filters out chats that took place within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.properties.<namespace>.<name>.<filter_type></code><sup><strong>1</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.agents.<string_filter_type></code><sup><strong>2</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below; <code>exists</code> set to <code>false</code> will return unassigned chats; <code>true</code> will return the assigned ones.</td></tr><tr><td><code>filters.tags.<string_filter_type></code><sup><strong>2</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.sales.<integer_filter_type></code><sup><strong>3</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.goals.<integer_filter_type></code><sup><strong>3</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.surveys.<survey></code><sup><strong>4</strong></sup></td><td>No</td><td><code>array</code></td><td>Described below.</td></tr><tr><td><code>filters.event_types.<event_type_filter_type></code><sup><strong>5</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.groups.<integer_filter_type></code><sup><strong>3</strong></sup></td><td>No</td><td><code>array</code></td><td>Array of group IDs.</td></tr><tr><td><code>filters.greetings.from</code></td><td>No</td><td><code>string</code></td><td>Filters out chats started from a greeting that was sent within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.greetings.to</code></td><td>No</td><td><code>string</code></td><td>Filters out chats started from a greeting that was sent within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.greetings.<filter_type></code><sup><strong>1</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.greetings.groups.<integer_filter_type></code><sup><strong>3</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.agent_response.exists</code></td><td>No</td><td><code>bool</code></td><td></td></tr><tr><td><code>filters.agent_response.first</code></td><td>No</td><td><code>bool</code></td><td>Modifier that makes the other <code>agent_response</code> filters operate exclusively on the agents' first response.</td></tr><tr><td><code>filters.agent_response.agents.<string_filter_type></code><sup><strong>2</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below. Works only if the <code>agent_response.first</code> filter is set to <code>true</code>.</td></tr><tr><td><code>filters.agent_response.groups.<integer_filter_type></code><sup><strong>3</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below. Works only if the <code>agent_response.first</code> filter is set to <code>true</code>.</td></tr><tr><td><code>filters.customer_countries.<string_filter_type></code><sup><strong>2</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below. It supports country codes with the <code>ISO 3166-1 Alpha-2</code> format.</td></tr></tbody></table></div><p>If filters are provided, they must contain exactly one pair of time-based filters (<code>filters.from/to</code>, <code>filters.greetings.from/to</code>, or <code>filters.surveys.from/to</code>).</p><h4 class="heading"><a id="for-the-agents-reports" href="#for-the-agents-reports" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#for-the-agents-reports"><span class="icon icon-link"></span></a>For the Agents reports</a></h4><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>distribution</code></td><td>No</td><td><code>string</code></td><td>Allowed values: <code>hour</code>, <code>day</code>. Defaults to <code>day</code>.</td></tr><tr><td><code>timezone</code></td><td>No</td><td><code>string</code></td><td>IANA <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a> (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, <code>filters.from</code> is parsed to get it.</td></tr><tr><td><code>filters</code></td><td>No</td><td><code>object</code></td><td>If none provided, your report will span the last seven days.</td></tr><tr><td><code>filters.from</code></td><td>No</td><td><code>string</code></td><td>Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.to</code></td><td>No</td><td><code>string</code></td><td>Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.agents.<string_filter_type></code><sup><strong>2</strong></sup></td><td>No</td><td><code>any</code></td><td>Described below.</td></tr><tr><td><code>filters.groups.values</code></td><td>No</td><td><code>array</code></td><td>Array of group IDs.</td></tr></tbody></table></div><p>If filters are provided, they must contain exactly one time-based filter (<code>filters.from/to</code>).</p></div><style data-emotion-css="17buymi">.css-17buymi{width:100%;}@media (min-width:768px){.css-17buymi{padding:25px 25px 30px 0px;}}</style><div class="css-17buymi"></div></section><p><strong>1)</strong> <code><filter_type></code> can take the following values:</p><ul><li><code>exists</code> (<code>bool</code>)</li><li><code>values</code> (<code>type[]</code> - an array with a specific type for property: <code>string</code>, <code>int</code> or <code>bool</code>)</li><li><code>exclude_values</code> (<code>type[]</code> - an array with a specific type for property: <code>string</code>, <code>int</code> or <code>bool</code>)</li></ul><p>There's only one value allowed for a single property.</p><p>List of default properties can be found <a href="/docs/messaging/references/default-properties#reference"><strong>here</strong></a>.</p><p><strong>2)</strong> <code><string_filter_type></code> can take the following values:</p><ul><li><code>exists</code> (<code>bool</code>) - 馃挕 available only for the <a href="/docs/data-reporting/reports-api/v3.5#for-chats-reports">Chats</a> parameter value</li><li><code>values</code> (<code>string[]</code> - an array of strings)</li><li><code>exclude_values</code> (<code>string[]</code> - an array of strings)</li><li><code>require_every_value</code> (<code>bool</code>) - if set to <code>true</code>, will return only those chats that have all elements passed in <code>values</code> or <code>exclude_values</code></li></ul><p>You can pass only one of the following values at a time: <code>exists</code>, <code>values</code> or <code>exclude_values</code>.</p><p><strong>3)</strong> <code><integer_filter_type></code> can take the following values:</p><ul><li><code>exists</code> (<code>bool</code>)</li><li><code>values</code> (<code>int[]</code> - an array of integers)</li><li><code>exclude_values</code> (<code>int[]</code> - an array of integers)</li><li><code>require_every_value</code> (<code>bool</code>) - if set to <code>true</code>, will return only those chats that have all elements passed in <code>values</code> or <code>exclude_values</code></li></ul><p>You can pass only one of the following values at a time: <code>exists</code>, <code>values</code> or <code>exclude_values</code>.</p><p><strong>4)</strong> <code><survey></code> contains the following fields:</p><ul><li><code>type</code> (<code>string</code>) - allowed values: <code>pre_chat</code>, <code>post_chat</code></li><li><code>values</code> (<code>string[]</code>) - an array of answer_ids</li><li><code>exclude_values</code> (<code>string[]</code>) - an array of answer_ids</li><li><code>from</code> (<code>string</code>) - date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code></li><li><code>to</code> (<code>string</code>) - date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code></li><li><code>exists</code> (<code>bool</code>) - if set to <code>true</code>, will return only surveys with <code>survey_id</code></li><li><code>groups</code> (<code><integer_filter_type></code><sup><strong>3</strong></sup>)</li></ul><style data-emotion-css="1vuwrgc">.css-1vuwrgc{border:1px solid #e8e8e8;border-radius:6px;background-color:#f1f6f8;min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;margin:0 0 20px;max-width:100%;}.css-1vuwrgc .remark-highlight{min-height:0;}.css-1vuwrgc pre{min-height:0;}</style><div class="css-1vuwrgc"><style data-emotion-css="iwgofq">.css-iwgofq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;height:42px;background-color:#dee5e8;border-radius:5px 5px 0 0;font-size:13px;text-transform:uppercase;-webkit-letter-spacing:0.04em;-moz-letter-spacing:0.04em;-ms-letter-spacing:0.04em;letter-spacing:0.04em;}</style><div class="css-iwgofq"><style data-emotion-css="w6gvpm">.css-w6gvpm{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;}</style><span class="css-w6gvpm">Sample survey filter</span> <style data-emotion-css="1wp1vo7">.css-1wp1vo7{position:relative;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;width:45px;}</style><div class="css-1wp1vo7"><style data-emotion-css="xnt8k0">.css-xnt8k0{position:relative;min-height:18px;}</style><div class="css-xnt8k0"><style data-emotion-css="6oazep">.css-6oazep{position:absolute;top:0;left:0;right:0;text-align:right;text-transform:capitalize;line-height:20px;font-size:13px;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;opacity:0;-webkit-transition-delay:0.25s;transition-delay:0.25s;-webkit-transition:none;transition:none;}</style><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><style data-emotion-css="139ndot">.css-139ndot{position:absolute;top:0;right:0;text-align:right;max-width:24px;opacity:1;-webkit-transition-delay:0.25;transition-delay:0.25;-webkit-transition:opacity 0.25s ease-in-out;transition:opacity 0.25s ease-in-out;}.css-139ndot:hover{cursor:pointer;}</style><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><style data-emotion-css="ju12u0">.css-ju12u0{min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;max-width:100%;overflow:scroll;}.css-ju12u0 code{display:inline-block;}</style><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "surveys": [ { "type": "pre_chat", "from": "2021-01-01T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00", "values": [ "163672098710307655:0" ], "groups": { "values": [ 10 ] } }, { "type": "post_chat", "from": "2021-01-01T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00", "exclude_values": [ "183672098710307678:1" ] } ] }</code></pre></div></div></div><p><strong>5)</strong> <code><event_type_filter_type></code> can take the following values:</p><ul><li><code>values</code> (<code>string[]</code> - an array of <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#events">Event</a> types, duplicates are ignored)</li><li><code>exclude_values</code> (<code>string[]</code> - an array of <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#events">Event</a> types, duplicates are ignored)</li><li><code>require_every_value</code> (<code>bool</code>) - if set to <code>true</code>, will return only those chats that have all elements passed in <code>values</code> or <code>exclude_values</code></li></ul><p>You can pass only one of the following values at a time: <code>exists</code>, <code>values</code> or <code>exclude_values</code>.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample filters</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "from": "2021-01-01T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00", "properties": { "routing": { "continuous": { "values": [ true ] } } }, "agents": { "values": [ "joe@acme.com", "alice@acme.com" ] }, "tags": { "exclude_values": [ "spam" ] }, "event_types": { "values": [ "file" ] } }</code></pre></div></div></div><p>The JSON payload above translates into the following query string:</p><style data-emotion-css="16prjg8">.css-16prjg8{border:1px solid #e8e8e8;border-radius:6px;background-color:#505671;color:white;margin:0 0 20px;max-width:100%;--code-color:#f5fbff;--code-background:#505671;--code-string-color:#56d4bc;}</style><div class="css-16prjg8"><style data-emotion-css="13hnul0">.css-13hnul0{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;background-color:#383f54;border-radius:8px 8px 0 0;color:#dee5e8;}.css-13hnul0 code{font-size:12px;max-width:100%;-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;word-break:break-all;}.css-13hnul0 .code-sample-header{border:none;background-color:#383f54;color:#dee5e8;padding:0.2em 0;}</style><div class="css-13hnul0"><code class="code-sample-header">FILTERS AS QUERY STRING PARAMS</code><style data-emotion-css="1sg2lsz">.css-1sg2lsz{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell">?filters.from<span class="token operator">=</span><span class="token number">2021</span>-03-01T23:59:59-00:00 <span class="token operator">&</span>filters.to<span class="token operator">=</span><span class="token number">2021</span>-04-13T23:59:59-00:00 <span class="token operator">&</span>filters.properties<span class="token punctuation">[</span>routing<span class="token punctuation">]</span><span class="token punctuation">[</span>continuous<span class="token punctuation">]</span>.values<span class="token operator">=</span>true <span class="token operator">&</span>filters.agents.values<span class="token operator">=</span>joe@acme.com <span class="token operator">&</span>filters.agents.values<span class="token operator">=</span>alice@acme.com <span class="token operator">&</span>filters.tags.exclude_values<span class="token operator">=</span>spam <span class="token operator">&</span>filters.event_types.values<span class="token operator">=</span>file </code></pre></div></div></div><p>馃挕 Notice the square brackets <code>[]</code> when using GET query string params to define <code>properties.<namespace></code> and <code>properties.<namespace>.<name></code>.</p><h3 class="heading"><a id="chats" href="#chats" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#chats"><span class="icon icon-link"></span></a>Chats</a></h3><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="duration" href="#duration" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#duration"><span class="icon icon-link"></span></a>Duration</a></h4><p>Shows the average chatting duration of agents within a license.</p><h5 class="heading"><a id="specifics" href="#specifics" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/duration</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request" href="#request" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response" href="#response" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.count</code></td><td>The total number of chats <code>agents</code> had that <code>day</code>.</td></tr><tr><td><code>records.day.agents_chatting_duration</code></td><td>The average chat duration <code>agents</code> had that <code>day</code>.</td></tr><tr><td><code>records.day.duration</code></td><td>The average chat duration for that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><style data-emotion-css="is8b0c">.css-is8b0c{max-width:100%;}</style><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/duration <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "duration-report", "total": 369, "records": { "2021-04-08": { "agents_chatting_duration": 10800, "count": 37, "duration": 12100 }, "2021-04-09": { "agents_chatting_duration": 7200, "count": 48, "duration": 8400 }, "2021-04-10": { "agents_chatting_duration": 3600, "count": 59, "duration": 4000 }, "2021-04-11": { "agents_chatting_duration": 10800, "count": 21, "duration": 12200 }, "2021-04-12": {}, "2021-04-13": { "agents_chatting_duration": 7200, "count": 33, "duration": 8000 }, "2021-04-14": {}, "2021-04-15": { "agents_chatting_duration": 3600, "count": 171, "duration": 5500 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="tags" href="#tags" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#tags"><span class="icon icon-link"></span></a>Tags</a></h4><p>Shows the distribution of tags for chats.</p><h5 class="heading"><a id="specifics-1" href="#specifics-1" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-1"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/tags</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-1" href="#request-1" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-1"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-1" href="#response-1" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-1"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.<tag></code></td><td>The total number of chats tagged with <code><tag></code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/tags <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "tags-report", "total": 369, "records": { "2021-04-08": { "spam": 14, "support": 19 }, "2021-04-09": { "spam": 22, "support": 34 }, "2021-04-10": { "spam": 42, "support": 18 }, "2021-04-11": { "spam": 12, "support": 5 }, "2021-04-12": {}, "2021-04-13": { "spam": 7, "support": 5 }, "2021-04-14": {}, "2021-04-15": { "spam": 11, "support": 27 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="total-chats" href="#total-chats" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#total-chats"><span class="icon icon-link"></span></a>Total Chats</a></h4><p>Shows how many chats occurred during the specified period.</p><h5 class="heading"><a id="specifics-2" href="#specifics-2" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-2"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/total_chats</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-2" href="#request-2" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-2"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-2" href="#response-2" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-2"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.total</code></td><td>The total number of chats that <code>day</code>.</td></tr><tr><td><code>records.day.continuous</code></td><td>The number of continuous chats that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/total_chats <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "total-chats-report", "total": 369, "records": { "2021-04-08": { "total": 37, "continuous": 15 }, "2021-04-09": { "total": 48, "continuous": 1 }, "2021-04-10": { "total": 59, "continuous": 51 }, "2021-04-11": { "total": 21, "continuous": 7 }, "2021-04-12": {}, "2021-04-13": { "total": 33, "continuous": 30 }, "2021-04-14": {}, "2021-04-15": { "total": 171, "continuous": 52 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="ratings" href="#ratings" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#ratings"><span class="icon icon-link"></span></a>Ratings</a></h4><p>Shows the number of rated chats along with their ratings during a specified period of time.</p><h5 class="heading"><a id="specifics-3" href="#specifics-3" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-3"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/ratings</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-3" href="#request-3" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-3"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-3" href="#response-3" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-3"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.chats</code></td><td>The total number of chats that <code>day</code>.</td></tr><tr><td><code>records.day.bad</code></td><td>The number of chats rated <code>bad</code> that <code>day</code>.</td></tr><tr><td><code>records.day.good</code></td><td>The number of chats rated <code>good</code> that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/ratings <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "ratings-report", "total": 83, "records": { "2021-04-08": { "bad": 6, "chats": 10, "good": 5 }, "2021-04-09": { "bad": 8, "chats": 23, "good": 10 }, "2021-04-10": { "bad": 2, "chats": 17, "good": 10 }, "2021-04-11": { "bad": 1, "chats": 3 }, "2021-04-12": {}, "2021-04-13": { "chats": 2 }, "2021-04-14": {}, "2021-04-15": { "chats": 28, "good": 7 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="ranking" href="#ranking" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#ranking"><span class="icon icon-link"></span></a>Ranking</a></h4><p>Shows the ratio of good to bad ratings for each operator.</p><h5 class="heading"><a id="specifics-4" href="#specifics-4" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-4"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/ranking</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-4" href="#request-4" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-4"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>. 馃挕 Notice that the distribution parameter will have no effect on the response of this method.</p><h5 class="heading"><a id="response-4" href="#response-4" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-4"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>records</code></td><td>Contains the <code>agent</code> objects.</td></tr><tr><td><code>records.agent.total</code></td><td>The total number of chats an agent had in the specified period.</td></tr><tr><td><code>records.agent.good</code></td><td>The number of agent's chats rated <code>good</code>.</td></tr><tr><td><code>records.agent.bad</code></td><td>The number of agent's chats rated <code>bad</code>.</td></tr><tr><td><code>records.agent.score</code></td><td>The agent's score. <a href="https://www.livechat.com/help/agent-rankings/">Read more about how we calculate agent rankings...</a></td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/ranking <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "ranking-report", "records": { "smith@example.com": { "total": 2, "good": 0, "bad": 2, "score": 0.11473482425785904 }, "agent@example.com": { "total": 19, "good": 13, "bad": 6, "score": 0.42326713031463276 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="engagement" href="#engagement" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#engagement"><span class="icon icon-link"></span></a>Engagement</a></h4><p>Shows the distribution of chats based on <a href="https://www.livechat.com/help/manage-team-reports/#chat-engagement-report">engagement</a> during the specified period.</p><h5 class="heading"><a id="specifics-5" href="#specifics-5" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-5"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/engagement</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-5" href="#request-5" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-5"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-5" href="#response-5" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-5"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.total</code></td><td>The total number of chats that <code>day</code>.</td></tr><tr><td><code>records.day.started_by_customer_from_greeting</code></td><td>The number of chats from greetings (also knows as targeted messages) that <code>day</code>.</td></tr><tr><td><code>records.day.started_by_customer_without_greeting</code></td><td>The number of chats started by a customer that <code>day</code>.</td></tr><tr><td><code>records.day.started_by_agent</code></td><td>The number of chats started by an agent that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/engagement <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "engagement-report", "total": 7411, "records": { "2021-08-16": { "started_by_customer_from_greeting": 187, "started_by_customer_without_greeting": 689, "started_by_agent": 3 }, "2021-08-17": { "started_by_customer_from_greeting": 362, "started_by_customer_without_greeting": 1257, "started_by_agent": 2 }, "2021-08-18": { "started_by_customer_from_greeting": 339, "started_by_customer_without_greeting": 1247, "started_by_agent": 1 }, "2021-08-19": { "started_by_customer_from_greeting": 315, "started_by_customer_without_greeting": 1147, "started_by_agent": 1 }, "2021-08-20": { "started_by_customer_from_greeting": 277, "started_by_customer_without_greeting": 1051 }, "2021-08-21": { "started_by_customer_from_greeting": 240, "started_by_customer_without_greeting": 762 }, "2021-08-22": { "started_by_customer_from_greeting": 239, "started_by_customer_without_greeting": 729, "started_by_agent": 1 }, "2021-08-23": { "started_by_customer_from_greeting": 153, "started_by_customer_without_greeting": 529 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="greetings-conversion" href="#greetings-conversion" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#greetings-conversion"><span class="icon icon-link"></span></a>Greetings Conversion</a></h4><p>Shows the number of greetings sent to the customers and how many of those resulted in a chat or a goal. Greetings are also known as targeted messages. </p><p>The method will return only up to 100 values for each day. If there are more than 100 values, use the LiveChat App to access the full data for a given day.</p><h5 class="heading"><a id="specifics-6" href="#specifics-6" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-6"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/greetings_conversion</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-6" href="#request-6" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-6"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-6" href="#response-6" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-6"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.greeting_id.accepted</code></td><td>The number of chats started as a result of accepting a greeting that <code>day</code>.</td></tr><tr><td><code>records.day.greeting_id.canceled</code></td><td>The number of greetings customers dismissed that <code>day</code>.</td></tr><tr><td><code>records.day.greeting_id.displayed</code></td><td>The number of greetings displayed that <code>day</code>.</td></tr><tr><td><code>records.day.greeting_id.goals</code></td><td>The number of goals resulted from the greetings that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/greetings_conversion <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "distribution": "day", "filters": { "greetings": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00", "groups": { "values": [1] } } } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "greetings-conversion-report", "total": 3, "records": { "2021-09-20": {}, "2021-09-21": {}, "2021-09-22": {}, "2021-09-23": {}, "2021-09-24": {}, "2021-09-25": {}, "2021-09-26": {}, "2021-09-27": { "1": { "accepted": 1, "canceled": 0, "displayed": 2, "goals": 0 }, "18": { "accepted": 0, "canceled": 0, "displayed": 1, "goals": 0 }, "19": { "accepted": 2, "canceled": 0, "displayed": 2, "goals": 0 } }, "2021-09-28": {} } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="forms" href="#forms" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#forms"><span class="icon icon-link"></span></a>Forms</a></h4><p>Returns the number of submitted chat forms along with the count of specific answers.</p><h5 class="heading"><a id="specifics-7" href="#specifics-7" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-7"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/forms</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-7" href="#request-7" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-7"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>. 馃挕 Notice that the distribution parameter will have no effect on the response of this method.</p><h5 class="heading"><a id="response-7" href="#response-7" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-7"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>records</code></td><td>Contains <code>form</code> objects.</td></tr><tr><td><code>records[{form_index}]</code></td><td>Form at a given index.</td></tr><tr><td><code>records[{form_index}].form_id</code></td><td>Form ID.</td></tr><tr><td><code>records[{form_index}].count</code></td><td>Number of times this form was filled.</td></tr><tr><td><code>records[{form_index}].group_id</code></td><td>Group ID in which this <code>form</code> is.</td></tr><tr><td><code>records[{form_index}].fields</code></td><td>Contains <code>field</code> objects.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}]</code></td><td>Field at a given index.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].field_id</code></td><td>Field ID.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].label</code></td><td>Text label of form field.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].answers</code></td><td>List of <code>answer</code> objects.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].answers[{answer_index}]</code></td><td>Answer at a given index.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].answers[{answer_index}].answer_id</code></td><td>Answer ID.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].answers[{answer_index}].label</code></td><td>Text label of answer.</td></tr><tr><td><code>records[{form_index}].fields[{field_index}].answers[{answer_index}].count</code></td><td>Number of times this answer was selected for this field.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/forms <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "form-report", "records": [ { "form_id": "163654772984908812", "count": 5, "group_id": 0, "fields": [ { "field_id": "163654772984903574", "label": "Question:", "answers": [ { "answer_id": 0, "label": "First answer", "count": 3 }, { "answer_id": 1, "label": "Second answer", "count": 2 } ] } ] } ] }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="response-time" href="#response-time" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-time"><span class="icon icon-link"></span></a>Response Time</a></h4><p>Shows the average agents' response time within a licence.</p><h5 class="heading"><a id="specifics-8" href="#specifics-8" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-8"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/response_time</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-8" href="#request-8" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-8"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-8" href="#response-8" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-8"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.count</code></td><td>The total number of chats that <code>day</code>.</td></tr><tr><td><code>records.day.response_time</code></td><td>The average chat response time for that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/response_time <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "response-time-report", "total": 39, "records": { "2021-04-08": { "count": 3, "response_time": 14.22 }, "2021-04-09": { "count": 4, "response_time": 41.35 }, "2021-04-10": { "count": 3, "response_time": 10.1 }, "2021-04-11": { "count": 9, "response_time": 3.34 }, "2021-04-12": {}, "2021-04-13": { "count": 5, "response_time": 8.5 }, "2021-04-14": {}, "2021-04-15": { "count": 6, "response_time": 32.3 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="first-response-time" href="#first-response-time" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#first-response-time"><span class="icon icon-link"></span></a>First Response Time</a></h4><p>Shows the average agents' first response time within a licence.</p><h5 class="heading"><a id="specifics-9" href="#specifics-9" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-9"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/chats/first_response_time</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-9" href="#request-9" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-9"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-9" href="#response-9" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-9"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>The total number of chats in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.day.count</code></td><td>The total number of chats that <code>day</code>.</td></tr><tr><td><code>records.day.first_response_time</code></td><td>The average chat first response time for that <code>day</code>.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/chats/first_response_time <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "first-response-time-report", "total": 39, "records": { "2021-04-08": { "count": 3, "first_response_time": 14.22 }, "2021-04-09": { "count": 4, "first_response_time": 41.35 }, "2021-04-10": { "count": 3, "first_response_time": 10.1 }, "2021-04-11": { "count": 9, "first_response_time": 3.34 }, "2021-04-12": {}, "2021-04-13": { "count": 5, "first_response_time": 8.5 }, "2021-04-14": {}, "2021-04-15": { "count": 6, "first_response_time": 32.3 } } }</code></pre></div></div></div></div></section><h3 class="heading"><a id="agents" href="#agents" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#agents"><span class="icon icon-link"></span></a>Agents</a></h3><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="availability" href="#availability" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#availability"><span class="icon icon-link"></span></a>Availability</a></h4><p>Shows for how long an agent, group, or the whole account was available for chatting during a specified period of time.</p><h5 class="heading"><a id="specifics-10" href="#specifics-10" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-10"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/agents/availability</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-10" href="#request-10" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-10"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>. Depending on the distribution parameter the response will contain a different time resolution.</p><h5 class="heading"><a id="response-10" href="#response-10" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-10"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>total</code></td><td>Total time the chat was available in the specified date range.</td></tr><tr><td><code>records</code></td><td>Contains the <code>distribution</code> objects, for example, <code>day</code>.</td></tr><tr><td><code>records.hours</code></td><td>The total number of hours the chat was available that <code>day</code> (only for the <code>day</code> distribution).</td></tr><tr><td><code>records.minutes</code></td><td>The total number of minutes the chat was available that <code>hour</code> (only for the <code>hour</code> distribution).</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/agents/availability <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "availability-report", "total": 19.59, "records": { "2021-04-08": { "hours": 0 }, "2021-04-09": { "hours": 0 }, "2021-04-10": { "hours": 0.15 }, "2021-04-11": { "hours": 7.85 }, "2021-04-12": { "hours": 7.99 }, "2021-04-13": { "hours": 2.28 }, "2021-04-14": { "hours": 1.32 }, "2021-04-15": { "hours": 0 } } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="performance" href="#performance" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#performance"><span class="icon icon-link"></span></a>Performance</a></h4><p>Shows the total number of agent's chats, the number of good and bad rates they received, and how well they performed in the early stages of a chat. Additionally, the report shows the time an agent spent chatting, accepting and not accepting chats, as well as the total time they were logged in.</p><h5 class="heading"><a id="specifics-11" href="#specifics-11" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-11"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/agents/performance</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-11" href="#request-11" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-11"><span class="icon icon-link"></span></a>Request</a></h5><p>See <a href="/docs/data-reporting/reports-api#available-parameters-and-filters">available parameters and filters</a>.</p><h5 class="heading"><a id="response-11" href="#response-11" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-11"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>summary</code></td><td>Summary for all agents.</td></tr><tr><td><code>summary.chats_count</code></td><td>The total number of chats the agents had in the specified period of time.</td></tr><tr><td><code>summary.chats_rated_good</code></td><td>The number of chats rated <code>good</code>.</td></tr><tr><td><code>summary.chats_rated_bad</code></td><td>The number of chats rated <code>bad</code>.</td></tr><tr><td><code>summary.first_response_chats_count</code></td><td>The total number of chats in which the agents have replied to the first message sent by the customers.</td></tr><tr><td><code>summary.first_response_time</code></td><td>The average time in seconds the agents took to send a first reply to the customers' messages.</td></tr><tr><td><code>records</code></td><td>Contains the <code>agent</code> objects.</td></tr><tr><td><code>records.chats_count</code></td><td>The total number of chats the agent had in the specified period of time.</td></tr><tr><td><code>records.chats_rated_good</code></td><td>The number of agent's chats rated <code>good</code>.</td></tr><tr><td><code>records.chats_rated_bad</code></td><td>The number of agent's chats rated <code>bad</code>.</td></tr><tr><td><code>records.first_response_chats_count</code></td><td>The number of chats where the agent has replied to the first message sent by the customer.</td></tr><tr><td><code>records.first_response_time</code></td><td>The average time in seconds the agent took to send a first reply to the customers' messages.</td></tr><tr><td><code>records.accepting_chats_time</code></td><td>The time in seconds during which the agent had the <code>accepting_chats</code> status set.</td></tr><tr><td><code>records.chatting_time</code></td><td>The time in seconds during which the agent was chatting.</td></tr><tr><td><code>records.logged_in_time</code></td><td>The time in seconds during which the agent was logged in.</td></tr><tr><td><code>records.not_accepting_chats_time</code></td><td>The time in seconds during which the agent had the <code>not_accepting_chats</code> status set.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/agents/performance <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00" } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "performance-report", "records": { "smith@example.com": { "accepting_chats_time": 35296, "chats_count": 4, "chats_rated_bad": 0, "chats_rated_good": 2, "chatting_time": 55, "first_response_chats_count": 3, "first_response_time": 9.666666666666666, "logged_in_time": 45304, "not_accepting_chats_time": 10008 }, "agent@example.com": { "accepting_chats_time": 24567, "chats_count": 13, "chats_rated_bad": 3, "chats_rated_good": 5, "chatting_time": 275, "first_response_chats_count": 8, "first_response_time": 8.133333, "logged_in_time": 32110, "not_accepting_chats_time": 7543 } }, "summary": { "chats_count": 17, "chats_rated_bad": 3, "chats_rated_good": 7, "first_response_chats_count": 11, "first_response_time": 8.55151490909091 } }</code></pre></div></div></div></div></section><h3 class="heading"><a id="tags-1" href="#tags-1" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#tags-1"><span class="icon icon-link"></span></a>Tags</a></h3><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="chat-usage" href="#chat-usage" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#chat-usage"><span class="icon icon-link"></span></a>Chat Usage</a></h4><p>Shows the total number of chats marked with each tag listed in the report.</p><h5 class="heading"><a id="specifics-12" href="#specifics-12" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#specifics-12"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Method URL</strong></td><td><code>https://api.livechatinc.com/v3.5/reports/tags/chat_usage</code></td></tr><tr><td><strong>HTTP method</strong></td><td>POST, GET</td></tr><tr><td><strong>Required scopes</strong></td><td><code>reports_read</code></td></tr></tbody></table></div><h5 class="heading"><a id="request-12" href="#request-12" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#request-12"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>timezone</code></td><td>No</td><td><code>string</code></td><td>IANA <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a> (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, <code>filters.from</code> is parsed to get it.</td></tr><tr><td><code>filters</code></td><td>No</td><td><code>object</code></td><td>If none provided, your report will span the last seven days.</td></tr><tr><td><code>filters.from</code></td><td>No</td><td><code>string</code></td><td>Filters out chats that took place within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.to</code></td><td>No</td><td><code>string</code></td><td>Filters out chats that took place within the time range defined as <<code>from</code>,<code>to</code>>. Date & time format compatible with RFC3339 with optional resolution of microseconds, <code>YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM</code>.</td></tr><tr><td><code>filters.groups.values</code></td><td>No</td><td><code>[]int</code></td><td>Array of group IDs.</td></tr></tbody></table></div><h5 class="heading"><a id="response-12" href="#response-12" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#response-12"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>records</code></td><td>Contains the <code><tag>:<chat_count></code> pairs.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="css-is8b0c"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/reports/tags/chat_usage <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "from": "2021-04-08T00:00:00-00:00", "to": "2021-04-15T23:59:59-00:00", "groups": { "values": [ 0, 42 ] } } }'</span> </code></pre></div></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "name": "tags-chat-usage-report", "records": { "docs_feedback": 4, "spam": 3, "support": 3 } }</code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="contact-us" href="#contact-us" class="reference css-180507a"><a href="/docs/data-reporting/reports-api#contact-us"><span class="icon icon-link"></span></a>Contact us</a></h2><p>If you found a bug or a typo, you can create an issue on <a href="https://github.com/livechat/livechat-public-docs/">GitHub</a>. In case of any questions or feedback, don't hesitate to contact us at <a href="mailto:developers@text.com">developers@text.com</a></p><style data-emotion-css="1fsewzh">.css-1fsewzh{margin-top:50px;}.css-1fsewzh > label{margin:0 0 5px 0;}.css-1fsewzh label + div{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}</style></article></div><p>...</p></div><style data-emotion-css="1mpu5jj">.css-1mpu5jj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:space-evenly;-webkit-justify-content:space-evenly;-ms-flex-pack:space-evenly;justify-content:space-evenly;-webkit-align-items:start;-webkit-box-align:start;-ms-flex-align:start;align-items:start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;background-color:#f6f6f7;color:#424d57;min-height:248px;margin-bottom:45px;}@media (min-width:768px){.css-1mpu5jj{margin-bottom:0px;}}</style><div class="css-1mpu5jj"><style data-emotion-css="dtzkur">.css-dtzkur{width:100%;padding:20px;}@media (min-width:768px){.css-dtzkur{margin-top:75px;padding:0;width:160px;}}</style><div class="css-dtzkur"><style data-emotion-css="r8rj3w">.css-r8rj3w{font-weight:600;font-size:16px;line-height:24px;color:#424d57;}</style><div class="css-r8rj3w">Join the community</div><style data-emotion-css="1ws0nkq">.css-1ws0nkq{font-weight:400;font-size:12px;line-height:20px;color:#424d57;}</style><div class="css-1ws0nkq">Get in direct contact with us through Discord.</div><style data-emotion-css="652pjx">.css-652pjx:hover{-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://discord.gg/MGFyhbdFxt" target="_blank" rel="noopener noreferrer" class="css-652pjx"><style data-emotion-css="y77wuh">.css-y77wuh{margin-top:5px;}</style><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="20" height="16" viewBox="0 0 20 16" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_613_10386)"><path d="M16.9308 1.63294C15.6561 1.04804 14.2892 0.617109 12.8599 0.370298C12.8339 0.365535 12.8079 0.377439 12.7945 0.401247C12.6187 0.713926 12.4239 1.12184 12.2876 1.44246C10.7503 1.21232 9.22099 1.21232 7.71527 1.44246C7.57887 1.11471 7.37707 0.713926 7.20048 0.401247C7.18707 0.378233 7.16107 0.366329 7.13504 0.370298C5.70659 0.616321 4.33963 1.04725 3.06411 1.63294C3.05307 1.6377 3.04361 1.64564 3.03732 1.65595C0.444493 5.52959 -0.265792 9.30801 0.0826501 13.0396C0.0842267 13.0578 0.0944749 13.0753 0.108665 13.0864C1.81934 14.3427 3.47642 15.1054 5.10273 15.6109C5.12876 15.6188 5.15634 15.6093 5.1729 15.5879C5.55761 15.0625 5.90054 14.5086 6.19456 13.926C6.21192 13.8919 6.19535 13.8514 6.15989 13.838C5.61594 13.6316 5.098 13.38 4.59977 13.0943C4.56037 13.0713 4.55721 13.015 4.59347 12.988C4.69831 12.9094 4.80318 12.8277 4.9033 12.7451C4.92141 12.7301 4.94665 12.7269 4.96794 12.7364C8.24107 14.2308 11.7846 14.2308 15.0191 12.7364C15.0404 12.7261 15.0657 12.7293 15.0846 12.7443C15.1847 12.8269 15.2895 12.9094 15.3952 12.988C15.4314 13.015 15.4291 13.0713 15.3897 13.0943C14.8914 13.3856 14.3735 13.6316 13.8288 13.8372C13.7933 13.8507 13.7775 13.8919 13.7949 13.926C14.0952 14.5078 14.4381 15.0617 14.8157 15.5871C14.8315 15.6093 14.8599 15.6188 14.8859 15.6109C16.5201 15.1054 18.1772 14.3427 19.8879 13.0864C19.9028 13.0753 19.9123 13.0586 19.9139 13.0404C20.3309 8.72626 19.2154 4.97883 16.9568 1.65674C16.9513 1.64564 16.9419 1.6377 16.9308 1.63294ZM6.68335 10.7674C5.69792 10.7674 4.88594 9.86274 4.88594 8.75167C4.88594 7.6406 5.68217 6.7359 6.68335 6.7359C7.69239 6.7359 8.49651 7.64855 8.48073 8.75167C8.48073 9.86274 7.68451 10.7674 6.68335 10.7674ZM13.329 10.7674C12.3435 10.7674 11.5316 9.86274 11.5316 8.75167C11.5316 7.6406 12.3278 6.7359 13.329 6.7359C14.338 6.7359 15.1421 7.64855 15.1264 8.75167C15.1264 9.86274 14.338 10.7674 13.329 10.7674Z" fill="#424D57"></path></g><defs><clipPath id="clip0_613_10386"><rect width="20" height="15.493" fill="white" transform="translate(0 0.25354)"></rect></clipPath></defs></svg></i><div>Discord</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Follow us</div><div class="css-1ws0nkq">Follow our insightful tweets and interact with our content.</div><a href="https://twitter.com/TextPlatform" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-twitter undefined" viewBox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23z"></path></svg></i><div>Twitter</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contribute</div><div class="css-1ws0nkq">See something that's wrong or unclear? Submit a pull request.</div><a href="https://github.com/livechat/livechat-public-docs" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-github undefined" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2z"></path></svg></i><div>GitHub</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contact us</div><div class="css-1ws0nkq">Want to share feedback? Reach us at: <a href="mailto:developers@text.com">developers@text.com</a></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/data-reporting/reports-api","query":{},"buildId":"mT926s0W5VyhfFaApGsyO","assetPrefix":"/docs","runtimeConfig":{},"nextExport":true,"autoExport":true,"isFallback":false}</script><script nomodule="" src="/docs/_next/static/chunks/polyfills-c2dc1d9251306528e50c.js"></script><script src="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" async=""></script><script src="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" async=""></script><script src="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" async=""></script><script src="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" async=""></script><script src="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" async=""></script><script src="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" async=""></script><script src="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" async=""></script><script src="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" async=""></script><script src="/docs/_next/static/chunks/pages/data-reporting/reports-api-dd0bc2859bdc4d3aad93.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_buildManifest.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_ssgManifest.js" async=""></script></body></html>