Saved filters

Delete a saved filter

DELETE
/v1/saved-filters/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Saved-filter id (nanoid).

Match^[\w-]+$
Length1 <= length <= 32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/saved-filters/V1StGXR8_Z5jdHi6B-myT"
{
  "data": {
    "deleted": true
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "code": "string",
  "error": "string",
  "issues": [
    {
      "message": "string",
      "path": "string"
    }
  ]
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Save a filter POST

Save a named filter for a list target. For a market target, `query` is the target operation's request body without `pagination` (e.g. the body you would send to listOriginators) and is validated against it. Limit: 25 per target.

Get a saved filter (with the operation to run it) GET

Returns the saved `query` and the `operationId` to run it with. Check `fidelity` (`partial` → `unmapped` lists what the query omits; `ui_only` → nothing to run) and `stale` (the query no longer validates) before running.