Saved filters

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

GET
/v1/saved-filters/{id}

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.

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 GET "https://example.com/v1/saved-filters/V1StGXR8_Z5jdHi6B-myT"
{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "fidelity": "exact",
    "icon": {
      "color": "string",
      "type": "color"
    },
    "id": "string",
    "kind": "filter",
    "name": "string",
    "operationId": "string",
    "query": {
      "property1": null,
      "property2": null
    },
    "queryVersion": 0,
    "stale": true,
    "staleIssues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "target": "originators",
    "uiState": {
      "property1": null,
      "property2": null
    },
    "uiStateVersion": 0,
    "unmapped": [
      "string"
    ],
    "updatedAt": "2019-08-24T14:15:22Z",
    "visibility": "private"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "code": "string",
  "error": "string",
  "issues": [
    {
      "message": "string",
      "path": "string"
    }
  ]
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}