> ## Documentation Index
> Fetch the complete documentation index at: https://docs.commvoice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# analytics.filters

> Example response:
```json
{
"data": [
{
"label": "Sms Id",
"key": "sms_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Team Id",
"key": "team_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Updated Datetime",
"key": "updated_datetime",
"type": "date",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"greaterThan",
"lessThan",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Sms Campaign Id",
"key": "sms_campaign_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sms Campaign Send Id",
"key": "sms_campaign_send_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Segment Id",
"key": "segment_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Contact Id",
"key": "contact_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Phone",
"key": "phone_normalized",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Network Id",
"key": "network_id",
"type": "number",
"canGroup": true,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Country Id",
"key": "country_id",
"type": "number",
"canGroup": true,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Foreign Id",
"key": "foreign_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Fail Reason",
"key": "fail_reason",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sent",
"key": "is_sent",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Is Clicked",
"key": "is_clicked",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Is Lead",
"key": "is_lead",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Is Sale",
"key": "is_sale",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Unsubscribed Method",
"key": "unsubscribed_method",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Domain Id",
"key": "domain_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Shortened Url",
"key": "shortened_url",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Offer Id",
"key": "offer_id",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Campaign Text Id",
"key": "campaign_text_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Final Text",
"key": "final_text",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Text Parts",
"key": "text_parts",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Sms Routing Plan Id",
"key": "sms_routing_plan_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sms Routing Plan Rule Id",
"key": "sms_routing_plan_rule_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sms Routing Route Id",
"key": "sms_routing_route_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sms Rule Selected Data",
"key": "sms_rule_selected_data",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sender Id",
"key": "sender_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sender Id Id",
"key": "sender_id_id",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sms Parts",
"key": "sms_parts",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Dlr Code",
"key": "dlr_code",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Dlr Str",
"key": "dlr_str",
"type": "text",
"canGroup": false,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Sent At",
"key": "sent_at",
"type": "date",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"greaterThan",
"lessThan",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Time Clicked",
"key": "time_clicked",
"type": "date",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"greaterThan",
"lessThan",
"inRange",
"blank",
"notBlank"
]
},
{
"label": "Campaign Name",
"key": "campaign_name",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Network Brand",
"key": "network_brand",
"type": "text",
"canGroup": true,
"operators": [
"contains",
"notContains",
"equals",
"notEqual",
"startsWith",
"endsWith",
"blank",
"notBlank"
]
},
{
"label": "Ctr",
"key": "ctr",
"type": "number",
"canGroup": false,
"operators": [
"equals",
"notEqual",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"inRange",
"blank",
"notBlank"
]
}
]
}
```



## OpenAPI

````yaml https://api.comm.com/docs/api.json get /v1/analytics/filters
openapi: 3.1.0
info:
  title: Commvoice API
  version: '1'
servers:
  - url: https://api.comm.com/api
    description: Live
security:
  - http: []
paths:
  /v1/analytics/filters:
    get:
      tags:
        - Analytics
        - DataGrid
      summary: analytics.filters
      description: |-
        Example response:
        ```json
        {
        "data": [
        {
        "label": "Sms Id",
        "key": "sms_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Team Id",
        "key": "team_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Updated Datetime",
        "key": "updated_datetime",
        "type": "date",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "greaterThan",
        "lessThan",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Campaign Id",
        "key": "sms_campaign_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Campaign Send Id",
        "key": "sms_campaign_send_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Segment Id",
        "key": "segment_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Contact Id",
        "key": "contact_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Phone",
        "key": "phone_normalized",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Network Id",
        "key": "network_id",
        "type": "number",
        "canGroup": true,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Country Id",
        "key": "country_id",
        "type": "number",
        "canGroup": true,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Foreign Id",
        "key": "foreign_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Fail Reason",
        "key": "fail_reason",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sent",
        "key": "is_sent",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Is Clicked",
        "key": "is_clicked",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Is Lead",
        "key": "is_lead",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Is Sale",
        "key": "is_sale",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Unsubscribed Method",
        "key": "unsubscribed_method",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Domain Id",
        "key": "domain_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Shortened Url",
        "key": "shortened_url",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Offer Id",
        "key": "offer_id",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Campaign Text Id",
        "key": "campaign_text_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Final Text",
        "key": "final_text",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Text Parts",
        "key": "text_parts",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Routing Plan Id",
        "key": "sms_routing_plan_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Routing Plan Rule Id",
        "key": "sms_routing_plan_rule_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Routing Route Id",
        "key": "sms_routing_route_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Rule Selected Data",
        "key": "sms_rule_selected_data",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sender Id",
        "key": "sender_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sender Id Id",
        "key": "sender_id_id",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sms Parts",
        "key": "sms_parts",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Dlr Code",
        "key": "dlr_code",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Dlr Str",
        "key": "dlr_str",
        "type": "text",
        "canGroup": false,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Sent At",
        "key": "sent_at",
        "type": "date",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "greaterThan",
        "lessThan",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Time Clicked",
        "key": "time_clicked",
        "type": "date",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "greaterThan",
        "lessThan",
        "inRange",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Campaign Name",
        "key": "campaign_name",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Network Brand",
        "key": "network_brand",
        "type": "text",
        "canGroup": true,
        "operators": [
        "contains",
        "notContains",
        "equals",
        "notEqual",
        "startsWith",
        "endsWith",
        "blank",
        "notBlank"
        ]
        },
        {
        "label": "Ctr",
        "key": "ctr",
        "type": "number",
        "canGroup": false,
        "operators": [
        "equals",
        "notEqual",
        "lessThan",
        "lessThanOrEqual",
        "greaterThan",
        "greaterThanOrEqual",
        "inRange",
        "blank",
        "notBlank"
        ]
        }
        ]
        }
        ```
      operationId: dataGrid.filters
      parameters:
        - name: type
          in: query
          required: true
          schema:
            type: string
            enum:
              - sms_contacts
              - sms_reports
              - route_company
              - connected_routes
      responses:
        '200':
          description: Array of `DataGridFilterResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataGridFilterResource'
                required:
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    DataGridFilterResource:
      type: object
      properties:
        label:
          type: string
        key:
          type: string
        type:
          type: string
        sortable:
          type: boolean
        canGroup:
          type: boolean
        operators:
          type: array
          items:
            type: string
      required:
        - label
        - key
        - type
        - sortable
        - canGroup
      title: DataGridFilterResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    http:
      type: http
      scheme: bearer
      bearerFormat: JWT

````