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

# Get filter value suggestions

> Retrieves autocomplete suggestions for specified filter parameter values observed within the current client account during the requested time range. Use the returned `value` in the filter parameters of an analytics data request ([GET /v1/analytics/requests](/docs/api-reference/waap/analytics/get-request-log-data) and [GET /v1/analytics/traffic-filtered](/docs/api-reference/waap/analytics/get-filtered-traffic-data)). `count` reports how many times the value was observed in the requested range.



## OpenAPI

````yaml /api-reference/services_docs_mintlify/waap_api.yaml get /waap/v1/analytics/filters/{type}
openapi: 3.1.0
info:
  title: Gcore OpenAPI – WAAP API
  description: >-
    This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore
    products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS
    Protection, Object Storage, Streaming, and FastEdge services.
  contact:
    email: support@gcore.com
  version: 8e206f8f4169
servers:
  - url: https://api.gcore.com
security:
  - APIKey: []
tags:
  - name: API Discovery
  - name: Advanced Rules
  - name: Analytics
  - name: Custom Page Sets
  - name: Custom Rules
  - name: Domains
  - name: Filter Templates
  - name: Firewall Rules
  - name: IP Reputation
  - name: IP Spotlight
  - name: Network Organizations
  - name: Policies
  - name: Security Insights
  - name: Tags
  - name: WAAP Service
paths:
  /waap/v1/analytics/filters/{type}:
    get:
      tags:
        - Analytics
      summary: Get filter value suggestions
      description: >-
        Retrieves autocomplete suggestions for specified filter parameter values
        observed within the current client account during the requested time
        range. Use the returned `value` in the filter parameters of an analytics
        data request ([GET
        /v1/analytics/requests](/docs/api-reference/waap/analytics/get-request-log-data)
        and [GET
        /v1/analytics/traffic-filtered](/docs/api-reference/waap/analytics/get-filtered-traffic-data)).
        `count` reports how many times the value was observed in the requested
        range.
      operationId: get_filter_values_v1_analytics_filters__type__get
      parameters:
        - name: type
          in: path
          required: true
          schema:
            enum:
              - user-agent-clients
              - user-agent-devices
              - organizations
            type: string
            description: Parsed user-agent field type.
            title: Type
          description: Parsed user-agent field type.
        - name: domains
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              exclusiveMinimum: 0
              description: Domain ID
            description: >-
              List of domain IDs. Empty list means all domains belonging to the
              current account.
            example:
              - 1
              - 2
              - 3
            examples:
              - - 1
                - 2
                - 3
            title: Domains
          description: >-
            List of domain IDs. Empty list means all domains belonging to the
            current account.
        - name: name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                minLength: 2
                maxLength: 100
              - type: 'null'
            description: >-
              Case-insensitive partial autocomplete pattern matched against the
              value name by the value provider. Must be between 2 and 100
              characters; empty or omitted returns the available suggestions for
              the current account and time range.
            title: Name
          description: >-
            Case-insensitive partial autocomplete pattern matched against the
            value name by the value provider. Must be between 2 and 100
            characters; empty or omitted returns the available suggestions for
            the current account and time range.
        - name: ordering
          in: query
          required: false
          schema:
            enum:
              - count
              - value
            type: string
            description: >-
              Suggestion ordering. `count` sorts by observed occurrence count
              descending (most frequent first) with value as a tie breaker;
              `value` sorts alphabetically by value ascending with count as a
              tie breaker.
            default: count
            title: Ordering
          description: >-
            Suggestion ordering. `count` sorts by observed occurrence count
            descending (most frequent first) with value as a tie breaker;
            `value` sorts alphabetically by value ascending with count as a tie
            breaker.
        - name: start
          in: query
          required: true
          schema:
            type: string
            description: >-
              Filter data items starting from a specified date in ISO 8601
              format
            example: '2024-04-13T00:00:00+01:00'
            examples:
              - '2024-04-13T00:00:00+01:00'
            title: Start
          description: Filter data items starting from a specified date in ISO 8601 format
        - name: end
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter data items up to a specified end date in ISO 8601 format.
              If not provided, defaults to the current date and time.
            examples:
              - '2024-04-14T12:00:00Z'
            title: End
          description: >-
            Filter data items up to a specified end date in ISO 8601 format. If
            not provided, defaults to the current date and time.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 50
            description: Number of items to return
            default: 50
            title: Limit
          description: Number of items to return
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 100000
            minimum: 0
            description: Number of items to skip
            default: 0
            title: Offset
          description: Number of items to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_FilterValueSuggestion_'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                type: http-bad-request
                title: Bad Request
                status: 400
                detail: 'Invalid domain name: '''''''''
          description: Bad Request
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              example:
                detail: Auth token is missing or invalid
        '403':
          description: Unauthenticated
          content:
            application/problem+json:
              example:
                detail: Permission denied
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                type: http-not-found
                title: Not Found
                status: 404
                detail: The resource is not found
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/APICompositeError'
              example:
                type: request-validation-failed
                title: Request validation error.
                status: 422
                detail: One or more fields have validation errors.
                errors:
                  - loc:
                      - body
                      - name
                    detail: Input should be a valid string
                  - loc:
                      - body
                      - date
                    detail: Field required
                  - loc:
                      - query
                      - limit
                    detail: Field required
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                type: internal-server-error
                title: Internal server error.
                status: 500
                detail: >-
                  An unexpected condition was encountered which prevented the
                  server from fulfilling the request.
          description: Internal Server Error
components:
  schemas:
    PaginatedResponse_FilterValueSuggestion_:
      properties:
        limit:
          type: integer
          title: Limit
          description: Number of items requested in the response
        offset:
          type: integer
          title: Offset
          description: Items response offset used
        count:
          type: integer
          title: Count
          description: Number of items contain in the response
        results:
          items:
            $ref: '#/components/schemas/FilterValueSuggestion'
          type: array
          title: Results
          description: List of items returned in the response following given criteria
      type: object
      required:
        - limit
        - offset
        - count
        - results
      title: PaginatedResponse[FilterValueSuggestion]
    APIError:
      properties:
        type:
          type: string
          title: Type
          description: A URI identifier that categorizes the type of error.
        title:
          type: string
          title: Title
          description: A brief, human-readable title for the error.
        status:
          type: integer
          title: Status
          description: The HTTP status code applicable to this error.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: A detailed human-readable explanation of the error.
      type: object
      required:
        - type
        - title
        - status
        - detail
      title: APIError
    APICompositeError:
      properties:
        type:
          type: string
          title: Type
          description: A URI identifier that categorizes the type of error.
        title:
          type: string
          title: Title
          description: A brief, human-readable title for the error.
        status:
          type: integer
          title: Status
          description: The HTTP status code applicable to this error.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: A detailed human-readable explanation of the error.
        errors:
          items:
            $ref: '#/components/schemas/APIFieldError'
          type: array
          title: Errors
          description: A list of detailed errors for individual fields.
      type: object
      required:
        - type
        - title
        - status
        - detail
        - errors
      title: APICompositeError
    FilterValueSuggestion:
      properties:
        value:
          type: string
          title: Value
          description: >-
            Value to use in an analytics query for the required filter
            parameter.
        count:
          type: integer
          title: Count
          description: Number of times this value was observed in the requested range.
      type: object
      required:
        - value
        - count
      title: FilterValueSuggestion
      description: A supported analytics filter value with its observed occurrence count.
    APIFieldError:
      properties:
        loc:
          anyOf:
            - items:
                anyOf:
                  - type: integer
                  - type: string
              type: array
            - {}
          title: Loc
          description: The location of the field or a character number causing the error.
        detail:
          type: string
          title: Detail
          description: A human-readable message describing the error.
      type: object
      required:
        - loc
        - detail
      title: APIFieldError
  securitySchemes:
    APIKey:
      description: >-
        API key for authentication. Make sure to include the word `apikey`,
        followed by a single space and then your token.

        Example: `apikey 1234$abcdef`
      type: apiKey
      in: header
      name: Authorization

````