---
updatedAt: 2026-09-08T20:26:09.000Z
agentTools:
  projectIndex: https://docs.observeinc.com/llms.txt
---

# Get a drop filter

Get a drop filter by its ID.

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Observe by Snowflake API",
    "description": "# Overview\nWelcome to the Observe API Docs!\n\nThe Observe API is a RESTful API. POST bodies and responses are typically JSON-encoded.\n\n## Authentication\nRequests to the Observe API are authenticated with an API token. The token can be supplied using HTTP Bearer authentication:\n```\n// passing token as bearer token\ncurl -H \"Authorization: Bearer <customerid> <token>\" https://<customerid>.<observe-domain>.com/v1/...\n```\n",
    "version": "1.0.230307"
  },
  "servers": [
    {
      "url": "https://{customerid}.observeinc.com",
      "description": "US west server",
      "variables": {
        "customerid": {
          "default": "OBSERVE_CUSTOMERID",
          "description": "The customer ID for your instance."
        }
      }
    },
    {
      "url": "https://{customerid}.{cluster}.observeinc.com",
      "description": "Specific regional cluster (prod)",
      "variables": {
        "customerid": {
          "default": "OBSERVE_CUSTOMERID",
          "description": "The customer ID for your instance."
        },
        "cluster": {
          "enum": [
            "eu-1",
            "ap-1"
          ],
          "default": "eu-1",
          "description": "For regional clusters, choose one."
        }
      }
    },
    {
      "url": "https://{customerid}.{domain}.com",
      "description": "Specific Observe server",
      "variables": {
        "customerid": {
          "default": "OBSERVE_CUSTOMERID",
          "description": "The customer ID for your instance."
        },
        "domain": {
          "default": "OBSERVE_DOMAIN",
          "description": "The Observe domain for your instance."
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Drop Filters",
      "x-displayName": "Drop Filter",
      "description": "Manage drop filters used to reduce ingest volume by dropping a\nconfigurable fraction of observations matching an OPAL predicate.\nLearn more about [drop filters](https://docs.observeinc.com/docs/drop-filters).\n"
    }
  ],
  "paths": {
    "/v1/ingest/filters/{id}": {
      "get": {
        "summary": "Get a drop filter",
        "description": "Get a drop filter by its ID.",
        "operationId": "GetIngestFilter",
        "tags": [
          "Drop Filters"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IngestFilters-Id"
          },
          {
            "$ref": "#/components/parameters/ExpandParam"
          }
        ],
        "responses": {
          "200": {
            "description": "Drop filter queried successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IngestFilters-Resource"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/ErrorResponse-400"
          },
          "401": {
            "$ref": "#/components/responses/ErrorResponse-401"
          },
          "403": {
            "$ref": "#/components/responses/ErrorResponse-403"
          },
          "404": {
            "$ref": "#/components/responses/ErrorResponse-404"
          },
          "429": {
            "$ref": "#/components/responses/ErrorResponse-429"
          },
          "5XX": {
            "$ref": "#/components/responses/ErrorResponse-5XX"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "Authorization: Bearer <customerid> <apitoken>\n"
      }
    },
    "schemas": {
      "ObjectId": {
        "type": "string",
        "format": "ObjectId"
      },
      "User": {
        "title": "User",
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "title": "User Identifier",
            "$ref": "#/components/schemas/ObjectId"
          },
          "label": {
            "title": "User Label",
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          }
        }
      },
      "ErrorMessage": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A stable, machine-readable identifier for the kind of error."
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        },
        "required": [
          "type",
          "message"
        ]
      },
      "Time": {
        "type": "string",
        "format": "RFC3339"
      },
      "ObjectRef": {
        "title": "ObjectRef",
        "type": "object",
        "description": "A reference to another resource. Always carries the id; the optional `record` field carries the brief metadata, populated when expand=true. Brief expansion applies to one layer only — fields inside `record` that are themselves ObjectRefs (e.g. `record.managedBy`) are returned id-only, never with their own `record` populated. CEL filter expressions can deeper-resolve via lazy wrapper resolution if needed.\n",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ObjectId"
          },
          "record": {
            "$ref": "#/components/schemas/ObjectBrief"
          }
        }
      },
      "ObjectBrief": {
        "title": "ObjectBrief",
        "type": "object",
        "description": "Brief record fields for an ObjectRef. This type is polymorphic: additional fields pointing to specific object types (e.g. dataset, dashboard, monitor) may be added in the future as needed.\n",
        "required": [
          "label",
          "description",
          "iconUrl",
          "managedBy"
        ],
        "properties": {
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "iconUrl": {
            "type": "string"
          },
          "managedBy": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ObjectRef"
              },
              {
                "type": "null"
              }
            ],
            "description": "Owner/manager of this object. Always returned as an id-only ObjectRef even when the parent was requested with expand=true: `expand` populates a single layer of brief data, so `record.managedBy` on a brief is itself never expanded. Pass the inner id back through a separate request (or filter via CEL, which lazily resolves) to access the manager's brief."
          }
        }
      },
      "DatasetContentType": {
        "title": "DatasetContentType",
        "type": "string",
        "description": "The type of data a dataset contains. For Resource datasets, this is\ndetermined by the dataset kind. For other kinds, it is derived from the\ndataset's interface bindings. Returns Unknown if no recognized interface\nis found.\n",
        "enum": [
          "Unknown",
          "Resource",
          "Log",
          "Metric",
          "OTelSpan",
          "OTelTrace"
        ]
      },
      "DatasetBrief": {
        "title": "DatasetBrief",
        "type": "object",
        "description": "Brief record fields for a DatasetRef (label, description, iconUrl, contentType). Field naming mirrors ObjectBrief in this same file (iconUrl, not icon) for consistency across reference-brief pairs.\n",
        "required": [
          "label",
          "description",
          "iconUrl",
          "contentType"
        ],
        "properties": {
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "iconUrl": {
            "type": "string"
          },
          "contentType": {
            "$ref": "#/components/schemas/DatasetContentType",
            "description": "The type of data the referenced dataset contains — Resource, Log,\nMetric, OTelSpan, OTelTrace, or Unknown. Derived from the dataset's\nkind and interface bindings.\n"
          }
        }
      },
      "DatasetRef": {
        "title": "DatasetRef",
        "type": "object",
        "description": "A reference to a dataset. Always carries the id; the optional `record` field carries the brief metadata, populated when expand=true. Mirrors ObjectRef (see ObjectRef / ObjectBrief in this file).\n",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ObjectId"
          },
          "record": {
            "$ref": "#/components/schemas/DatasetBrief"
          }
        }
      },
      "IngestFilters-Resource": {
        "title": "IngestFiltersObject",
        "type": "object",
        "description": "A drop filter resource.",
        "required": [
          "id",
          "label",
          "description",
          "iconUrl",
          "sourceDataset",
          "pipeline",
          "layout",
          "dropRate",
          "enabled",
          "managedBy",
          "createdAt",
          "createdBy",
          "updatedAt",
          "updatedBy"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ObjectId",
            "readOnly": true,
            "description": "Unique, immutable identifier of the filter."
          },
          "label": {
            "type": "string",
            "description": "Mutable display name of the filter."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Optional human-readable description."
          },
          "iconUrl": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "Optional icon shown alongside the filter in the UI."
          },
          "sourceDataset": {
            "$ref": "#/components/schemas/DatasetRef",
            "description": "The source dataset this filter applies to. Cannot be changed after creation."
          },
          "pipeline": {
            "type": "string",
            "description": "OPAL pipeline expression defining the filter predicate. Observations matching the pipeline are candidates for dropping, subject to `dropRate`."
          },
          "layout": {
            "type": [
              "object",
              "null"
            ],
            "description": "Reserved for UI state. Stored and returned verbatim, never interpreted by Observe. Safe to omit."
          },
          "dropRate": {
            "type": "number",
            "format": "double",
            "minimum": 0,
            "maximum": 1,
            "description": "Fraction (0.0-1.0) of matching observations to drop. 1.0 = drop all matches; 0.0 = drop none."
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether the filter is actively dropping observations. Disabled filters are retained but have no effect on ingest."
          },
          "managedBy": {
            "readOnly": true,
            "description": "Identifies the owner/manager of this filter. Managed filters cannot be modified through the API.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/ObjectRef"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdBy": {
            "$ref": "#/components/schemas/User",
            "readOnly": true,
            "description": "User who created the filter."
          },
          "createdAt": {
            "$ref": "#/components/schemas/Time",
            "readOnly": true,
            "description": "When the filter was created."
          },
          "updatedBy": {
            "$ref": "#/components/schemas/User",
            "readOnly": true,
            "description": "User who most recently updated the filter."
          },
          "updatedAt": {
            "$ref": "#/components/schemas/Time",
            "readOnly": true,
            "description": "When the filter was last updated."
          }
        }
      }
    },
    "parameters": {
      "ExpandParam": {
        "name": "expand",
        "in": "query",
        "description": "Whether to expand resources referenced in the response to include additional fields",
        "schema": {
          "type": "boolean"
        }
      },
      "IngestFilters-Id": {
        "in": "path",
        "name": "id",
        "schema": {
          "type": "string",
          "format": "int64"
        },
        "required": true,
        "description": "The ID of the drop filter.",
        "example": "41030001"
      }
    },
    "responses": {
      "ErrorResponse-400": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      },
      "ErrorResponse-401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      },
      "ErrorResponse-403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      },
      "ErrorResponse-404": {
        "description": "Resource not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      },
      "ErrorResponse-429": {
        "description": "Rate limit reached",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      },
      "ErrorResponse-5XX": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        }
      }
    }
  }
}
````