FilterModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-filter-model-schema.json",
  "title": "FilterModel",
  "description": "Model for Filter",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-alerts-api-openapi.yml#/components/schemas/FilterModel",
  "properties": {
    "detailed": {
      "description": "Detailed",
      "type": "boolean"
    },
    "fields": {
      "description": "Array of specific fields to return",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "filters": {
      "description": "Filtering parameters. \n\nFor filter names, refer to List Filters API. \n\nFor filter values, refer to List filter suggestions. \n\nThe only exception is **resource.tagv2** filter name, provide filter value for it in the following format: \"{\"key\":\"'CustomerTagKey'\",\"value\":\"'CustomerTagValue'\"}\"",
      "items": {
        "$ref": "#/$defs/UIFilterModel"
      },
      "type": "array"
    },
    "groupBy": {
      "description": "For asset or data inventory only. Group returned items by **cloud.type**, **cloud.service**, **cloud.region**, **cloud.account**, and/or **resource.type**",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "limit": {
      "description": "Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.",
      "type": "number"
    },
    "offset": {
      "description": "The number of items to skip before selecting items to return. Default is zero",
      "type": "number"
    },
    "pageToken": {
      "description": "Setting this pagination Token to the **nextPageToken** from a response object returns the next page of data ",
      "type": "string"
    },
    "sortBy": {
      "description": "Array of sort properties. Append **:asc** or  **:desc** to the key to sort by ascending or descending order respectively. Example sort properties are **id:asc** and **timestamp:desc**",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "timeRange": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel_2"
        },
        {
          "description": "Time range"
        }
      ]
    }
  },
  "type": "object",
  "$defs": {
    "AbsoluteTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel_2"
        },
        {
          "description": "Model for AbsoluteTimeRangeConfig",
          "properties": {
            "type": {
              "type": "string"
            },
            "value": {
              "allOf": [
                {
                  "$ref": "#/$defs/TimeModel"
                },
                {
                  "description": "Time range object"
                }
              ]
            }
          },
          "required": [
            "value"
          ],
          "type": "object"
        }
      ]
    },
    "RelativeTimeDurationModel": {
      "description": "Model for RelativeTimeDuration",
      "properties": {
        "amount": {
          "description": "Number of time units",
          "format": "int32",
          "type": "integer"
        },
        "unit": {
          "description": "Time unit",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "RelativeTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel_2"
        },
        {
          "description": "Model for RelativeTimeRangeConfig",
          "properties": {
            "relativeTimeType": {
              "description": "Direction in which to count time. Default = BACKWARD",
              "enum": [
                "BACKWARD",
                "FORWARD"
              ],
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "value": {
              "allOf": [
                {
                  "$ref": "#/$defs/RelativeTimeDurationModel"
                },
                {
                  "description": "Time range object"
                }
              ]
            }
          },
          "required": [
            "value"
          ],
          "type": "object"
        }
      ]
    },
    "TimeModel": {
      "description": "Model for Time",
      "properties": {
        "endTime": {
          "description": "End timestamp",
          "format": "int64",
          "type": "integer"
        },
        "startTime": {
          "description": "Start timestamp",
          "format": "int64",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "TimeRangeConfigModel_2": {
      "description": "See the [Time Range Model](/prisma-cloud/api/cspm/api-time-range-model) for details.\n",
      "oneOf": [
        {
          "$ref": "#/$defs/RelativeTimeRangeConfigModel"
        },
        {
          "$ref": "#/$defs/AbsoluteTimeRangeConfigModel"
        },
        {
          "$ref": "#/$defs/ToNowTimeRangeConfigModel"
        }
      ],
      "properties": {
        "type": {
          "description": "Time type",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "ToNowTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel_2"
        },
        {
          "description": "Model for ToNowTimeRangeConfig",
          "properties": {
            "value": {
              "description": "Time range object",
              "enum": [
                "MINUTE",
                "HOUR",
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR",
                "EPOCH",
                "LOGIN"
              ],
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    },
    "UIFilterModel": {
      "description": "Model for UIFilter",
      "properties": {
        "name": {
          "description": "Name",
          "type": "string"
        },
        "operator": {
          "description": "Operator",
          "enum": [
            "="
          ],
          "type": "string"
        },
        "value": {
          "description": "Value",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}