authentik/website/docs/developer-docs/api/reference/events-events-volume-list.api.mdx

---
id: events-events-volume-list
title: "events_events_volume_list"
description: "Get event volume for specified filters and timeframe"
sidebar_label: "events_events_volume_list"
hide_title: true
hide_table_of_contents: true
api: eJytVk1v2zgQ/SuEzoIVpD0UPq03CIJgm2yANruHIjBoaWyxpkiVpLz1Gv7vO0NKNl1bTqzNSZQ0M+/NDOdjk+gaDHdCq/siGSewAuXstH2stGwqmEphXZImBdjciJpkUfIOHPNiLEixuTbM1pCLuYCCzYV0YCzjqmBOVDA3vAI0UnM60K9k/G2TCDL1owGzxn+KRMYJzz1Emti8hIon403i1jX9sc4ItUi22/S05swg3FQFpF7tXz35nbSY1+oznEuBnk5FPYRVrpWDn27KG1dqI/6FYsrrs5Z+ZXgTLLDJzgJDC1LkPnH9rFvgShcgh2I+kDKboPLbYC6N/iHO49ksHADVy+EwT0ZU3KzZH7D2aC2ANgV49TQx8KMRBrAm5lxaSA8JHdr+uxR5iTceJN51zRoL7J8SFOvMMVcCM2Ab6ezotRvUUrHATV5eSGTCghrD+qpeRToVYuRuLs3gc6ezfUkTxxdU2W0jSfCLhbwxwq19vVMN4A+xxLcXksew1FpZsAR0fXVFD59n5egYXfPsuyW4zTExbgwnH4SDykbf9ew75Med60ZjYoTiDqxvWoXgC2xKlrqToXboRKDzc5qjZGRQIK8FGJ8VXvypJDrlTAMYkvWbZbdxTr91IDsLFEPhJBwQxYRtj+JOmfg4LGI9kfmLS1F4VXZrjDZHEVFaTf09nwL9t29Iwv7GIcsCTv/hRSEIlsunGG+7j8WeWmDWG48P7xiPO1BYwDmbPN33BKQAx4U8WST93sbpbw1EWW9Bz7iJn3CElpoG9gKcn6quxJcsVF33CIM5o1oGs+pGbmMkifJaZKsPmS/arkS/UFyCY1Gh7lwonduNED9usdmA8XyEmmsv2TqxV08TQg7Ur6+uP44+ja6PAv3Al9QnO62QLmZFVUugPkb5xLWAEDBxFPCkBCn1bwu9QxoJTWHHZAP2E39bQ097uP+KJoLb5IIdZ9lCuLKZjXJdZZGJbH+aST3LEEpln+9vbh+/3Ho3a21dxVVkPISatY92FTq1MEWXcuju1KaB5lhWS+RG/nq/Nu0N2PXddH8IEHigS1aiAyS22cy4hWcjt1v6HKYA3Y5CWD6T0bhZ4oiMdrIVlw2EYjsh3OtxtGP1+BFwDja481hBId7MBnJ7Zbs6y7d3t/ufXPZb15vg4w3vXZAfX83Uya3vXbDj5ewCCn4fHEjg0g3uDKlohxxI5miLO4O2WxMHYj3v970zKNFWuMd5oRcjCMgvc9hccNHBeUBtJOhN8hxqF2kdDWOysptld7fUqKmUoqHTDpm0O5D1buVQ68g2tjQv8VUvQWFb68g7ekcgHKX/AUWYKDs=
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"events_events_volume_list"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/events/events/volume/"}
>
  
</MethodEndpoint>



Get event volume for specified filters and timeframe

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"action","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"brand_name","schema":{"type":"string"},"description":"Brand name"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"client_ip","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"context_authorized_app","schema":{"type":"string"},"description":"Context Authorized application"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"context_model_app","schema":{"type":"string"},"description":"Context Model App"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"context_model_name","schema":{"type":"string"},"description":"Context Model Name"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"context_model_pk","schema":{"type":"string"},"description":"Context Model Primary Key"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"username","schema":{"type":"string"},"description":"Username"}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <li>
                        <div
                          style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
                        >
                          Array [
                        </div>
                      </li><SchemaItem
                        collapsible={false}
                        name={"x_cord"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"y_cord"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","readOnly":true}}
                      >
                        
                      </SchemaItem><li>
                        <div
                          style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                        >
                          ]
                        </div>
                      </li>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"[\n  {\n    \"x_cord\": 0,\n    \"y_cord\": 0\n  }\n]"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>