---
title: "ApiFilter"
url: "https://nov18-dev.movespot.fyi/apis/portal-application-analytics-2/versions/7eb4e759-6c13-4850-865d-25ae682ee61a/schemas/ApiFilter"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-application-analytics-2/versions/7eb4e759-6c13-4850-865d-25ae682ee61a.md

# ApiFilter

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Application Analytics
  version: 3.0.1
components:
  schemas:
    FilterType:
      description: The type of filter to apply.  `in` filters will limit results to
        only the specified values, while `not_in` filters will exclude the
        specified values.
      type: string
      enum:
        - in
        - not_in
    ApiFilter:
      type: object
      properties:
        field:
          description: The dimension to filter.
          type: string
          enum:
            - api
        operator:
          $ref: "#/components/schemas/FilterType"
        value:
          description: |
            The UUIDs of the API product versions to include in the results.
          type: array
          items:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      additionalProperties: false
      required:
        - field
        - operator
        - value
```
