Saved view service

Saved Views allow users to store and reuse filter and table display configurations across assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.

OpenAPI file: SavedViewService.json

Endpoints

Create saved view

POST /scout/saved-views/v1

Creates a new saved view in the given workspace. If no workspace is specified, it is created in the user’s default workspace.

Body

title string required

​

symbol Symbol

​

icon

Set type to "icon".

icon string

Icon name (e.g. castle)

emoji

Set type to "emoji".

emoji string

Emoji name (e.g. :castle:)

image

Set type to "image".

image string

Image url (e.g. https://example.com/image.png)

color Color

​

hexCode

Set type to "hexCode".

hexCode string

​

searchState SearchState required

​

asset

Set type to "asset".

asset AssetSearchState

​

Fields of AssetSearchState

sort AssetSortOptions

​

groupBy array of string

​

query SearchAssetsQuery required

​

run

Set type to "run".

run RunSearchState

​

Fields of RunSearchState

sort run.api.SortOptions

​

groupBy array of string

​

query api.SearchQuery required

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

Fields of ChecklistSearchState

sort checks.api.SortOptions

​

query ChecklistSearchQuery required

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

Fields of WorkbookSearchState

sort notebook.api.SortBy

​

query SearchNotebooksQuery required

​

template

Set type to "template".

template TemplateSearchState

​

Fields of TemplateSearchState

sort template.api.SortBy

Sort for templates view. Uses BE-supplied default if empty.

query SearchTemplatesQuery required

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

Fields of ProcedureSearchState

sort ProcedureSortOptions

​

query ProcedureSearchQuery required

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

Fields of ProcedureExecutionSearchState

sort ProcedureExecutionSortOptions

​

query ProcedureExecutionSearchQuery required

​

displayState DisplayState required

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Fields of TableState

columnVisibility map of ColumnId to boolean

​

columnSizing map of ColumnId to integer

​

columnOrder array of string

​

columnPinning ColumnPinningState

​

metricColumns MetricColumns

​

workspaceRid string (RID)

​

Response

savedView SavedView

​

Fields of SavedView

metadata SavedViewMetadata

​

Fields of SavedViewMetadata

rid string (RID)

​

resourceType ResourceType

​

title string

​

symbol Symbol

​

color Color

​

isArchived boolean

​

createdAt string (date-time)

​

createdBy string (RID)

​

updatedAt string (date-time)

​

searchState SearchState

​

asset

Set type to "asset".

asset AssetSearchState

​

run

Set type to "run".

run RunSearchState

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

template

Set type to "template".

template TemplateSearchState

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

displayState DisplayState

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Request

curl

curl -X POST "https://api.gov.nominal.io/api/scout/saved-views/v1" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "title": "<title>",
  "searchState": {
    "type": "asset",
    "asset": {
      "query": {
        "type": "searchText",
        "searchText": "<search text>"
      }
    }
  },
  "displayState": {
    "type": "displayStateV1",
    "displayStateV1": {
      "columnVisibility": {
        "<key>": true
      },
      "columnSizing": {
        "<key>": 1
      },
      "columnOrder": [
        "<column id>"
      ],
      "columnPinning": {
        "left": [
          "<column id>"
        ],
        "right": [
          "<column id>"
        ]
      },
      "metricColumns": {
        "type": "asset",
        "asset": {
          "metricColumns": {
            "<key>": {
              "metadata": {
                "title": "<title>"
              },
              "timeRange": {
                "type": "mostRecentRun",
                "mostRecentRun": {}
              },
              "aggregation": "TOTAL_COUNT",
              "data": {
                "type": "event",
                "event": {
                  "type": "archived",
                  "archived": true
                }
              }
            }
          }
        }
      }
    }
  }
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "title": "<title>",
        "searchState": {
            "type": "asset",
            "asset": {"query": {"type": "searchText", "searchText": "<search text>"}},
        },
        "displayState": {
            "type": "displayStateV1",
            "displayStateV1": {
                "columnVisibility": {"<key>": True},
                "columnSizing": {"<key>": 1},
                "columnOrder": ["<column id>"],
                "columnPinning": {"left": ["<column id>"], "right": ["<column id>"]},
                "metricColumns": {
                    "type": "asset",
                    "asset": {
                        "metricColumns": {
                            "<key>": {
                                "metadata": {"title": "<title>"},
                                "timeRange": {
                                    "type": "mostRecentRun",
                                    "mostRecentRun": {},
                                },
                                "aggregation": "TOTAL_COUNT",
                                "data": {
                                    "type": "event",
                                    "event": {"type": "archived", "archived": True},
                                },
                            },
                        },
                    },
                },
            },
        },
    },
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "title": "<title>",
        "searchState": {
            "type": "asset",
            "asset": {"query": {"type": "searchText", "searchText": "<search text>"}},
        },
        "displayState": {
            "type": "displayStateV1",
            "displayStateV1": {
                "columnVisibility": {"<key>": True},
                "columnSizing": {"<key>": 1},
                "columnOrder": ["<column id>"],
                "columnPinning": {"left": ["<column id>"], "right": ["<column id>"]},
                "metricColumns": {
                    "type": "asset",
                    "asset": {
                        "metricColumns": {
                            "<key>": {
                                "metadata": {"title": "<title>"},
                                "timeRange": {
                                    "type": "mostRecentRun",
                                    "mostRecentRun": {},
                                },
                                "aggregation": "TOTAL_COUNT",
                                "data": {
                                    "type": "event",
                                    "event": {"type": "archived", "archived": True},
                                },
                            },
                        },
                    },
                },
            },
        },
    },
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/saved-views/v1",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "title": "<title>",
                "searchState": {
                    "type": "asset",
                    "asset": {
                        "query": {"type": "searchText", "searchText": "<search text>"},
                    },
                },
                "displayState": {
                    "type": "displayStateV1",
                    "displayStateV1": {
                        "columnVisibility": {"<key>": True},
                        "columnSizing": {"<key>": 1},
                        "columnOrder": ["<column id>"],
                        "columnPinning": {
                            "left": ["<column id>"],
                            "right": ["<column id>"],
                        },
                        "metricColumns": {
                            "type": "asset",
                            "asset": {
                                "metricColumns": {
                                    "<key>": {
                                        "metadata": {"title": "<title>"},
                                        "timeRange": {
                                            "type": "mostRecentRun",
                                            "mostRecentRun": {},
                                        },
                                        "aggregation": "TOTAL_COUNT",
                                        "data": {
                                            "type": "event",
                                            "event": {
                                                "type": "archived",
                                                "archived": True,
                                            },
                                        },
                                    },
                                },
                            },
                        },
                    },
                },
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "savedView": {
    "metadata": {
      "rid": "<saved view rid>",
      "resourceType": "ASSET",
      "title": "<title>",
      "symbol": {
        "type": "icon",
        "icon": "<icon>"
      },
      "color": {
        "type": "hexCode",
        "hexCode": "<hex code>"
      },
      "isArchived": true,
      "createdAt": "2026-01-01T00:00:00Z",
      "createdBy": "<user rid>",
      "updatedAt": "2026-01-01T00:00:00Z"
    },
    "searchState": {
      "type": "asset",
      "asset": {
        "sort": {
          "isDescending": true,
          "field": "NAME",
          "sortKey": {
            "type": "field",
            "field": "NAME"
          }
        },
        "groupBy": [
          "<column id>"
        ],
        "query": {
          "type": "searchText",
          "searchText": "<search text>"
        }
      }
    },
    "displayState": {
      "type": "displayStateV1",
      "displayStateV1": {
        "columnVisibility": {
          "<key>": true
        },
        "columnSizing": {
          "<key>": 1
        },
        "columnOrder": [
          "<column id>"
        ],
        "columnPinning": {
          "left": [
            "<column id>"
          ],
          "right": [
            "<column id>"
          ]
        },
        "metricColumns": {
          "type": "asset",
          "asset": {
            "metricColumns": {
              "<key>": {
                "metadata": {
                  "title": "<title>",
                  "description": "<description>",
                  "symbol": {
                    "type": "icon",
                    "icon": "<icon>"
                  }
                },
                "timeRange": {
                  "type": "mostRecentRun",
                  "mostRecentRun": {}
                },
                "aggregation": "TOTAL_COUNT",
                "data": {
                  "type": "event",
                  "event": {
                    "type": "archived",
                    "archived": true
                  }
                },
                "style": {
                  "type": "RAW",
                  "value": [
                    {
                      "value": 1,
                      "color": "<color>",
                      "label": "<label>"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Get saved view

GET /scout/saved-views/v1/{savedViewRid}

Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.

Path parameters

savedViewRid string (RID) required

​

Response

savedView SavedView

​

Fields of SavedView

metadata SavedViewMetadata

​

Fields of SavedViewMetadata

rid string (RID)

​

resourceType ResourceType

​

title string

​

symbol Symbol

​

color Color

​

isArchived boolean

​

createdAt string (date-time)

​

createdBy string (RID)

​

updatedAt string (date-time)

​

searchState SearchState

​

asset

Set type to "asset".

asset AssetSearchState

​

run

Set type to "run".

run RunSearchState

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

template

Set type to "template".

template TemplateSearchState

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

displayState DisplayState

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Request

curl

curl "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>" \
  -H "Authorization: Bearer <api key>"

requests

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "savedView": {
    "metadata": {
      "rid": "<saved view rid>",
      "resourceType": "ASSET",
      "title": "<title>",
      "symbol": {
        "type": "icon",
        "icon": "<icon>"
      },
      "color": {
        "type": "hexCode",
        "hexCode": "<hex code>"
      },
      "isArchived": true,
      "createdAt": "2026-01-01T00:00:00Z",
      "createdBy": "<user rid>",
      "updatedAt": "2026-01-01T00:00:00Z"
    },
    "searchState": {
      "type": "asset",
      "asset": {
        "sort": {
          "isDescending": true,
          "field": "NAME",
          "sortKey": {
            "type": "field",
            "field": "NAME"
          }
        },
        "groupBy": [
          "<column id>"
        ],
        "query": {
          "type": "searchText",
          "searchText": "<search text>"
        }
      }
    },
    "displayState": {
      "type": "displayStateV1",
      "displayStateV1": {
        "columnVisibility": {
          "<key>": true
        },
        "columnSizing": {
          "<key>": 1
        },
        "columnOrder": [
          "<column id>"
        ],
        "columnPinning": {
          "left": [
            "<column id>"
          ],
          "right": [
            "<column id>"
          ]
        },
        "metricColumns": {
          "type": "asset",
          "asset": {
            "metricColumns": {
              "<key>": {
                "metadata": {
                  "title": "<title>",
                  "description": "<description>",
                  "symbol": {
                    "type": "icon",
                    "icon": "<icon>"
                  }
                },
                "timeRange": {
                  "type": "mostRecentRun",
                  "mostRecentRun": {}
                },
                "aggregation": "TOTAL_COUNT",
                "data": {
                  "type": "event",
                  "event": {
                    "type": "archived",
                    "archived": true
                  }
                },
                "style": {
                  "type": "RAW",
                  "value": [
                    {
                      "value": 1,
                      "color": "<color>",
                      "label": "<label>"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Update saved view

PUT /scout/saved-views/v1/{savedViewRid}

Updates metadata, search filters, or display settings for an existing saved view. Throws NOT_FOUND if the view doesn’t exist and INVALID_ARGUMENT if it is archived.

Path parameters

savedViewRid string (RID) required

​

Body

title string

​

symbol UpdateSymbol

​

symbol

Set type to "symbol".

symbol Symbol

​

icon

Set type to "icon".

icon string

Icon name (e.g. castle)

emoji

Set type to "emoji".

emoji string

Emoji name (e.g. :castle:)

image

Set type to "image".

image string

Image url (e.g. https://example.com/image.png)

clearSymbol

Set type to "clearSymbol".

clearSymbol Empty

​

color UpdateColor

​

color

Set type to "color".

color Color

​

hexCode

Set type to "hexCode".

hexCode string

​

clearColor

Set type to "clearColor".

clearColor Empty

​

searchState SearchState

​

asset

Set type to "asset".

asset AssetSearchState

​

Fields of AssetSearchState

sort AssetSortOptions

​

groupBy array of string

​

query SearchAssetsQuery required

​

run

Set type to "run".

run RunSearchState

​

Fields of RunSearchState

sort run.api.SortOptions

​

groupBy array of string

​

query api.SearchQuery required

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

Fields of ChecklistSearchState

sort checks.api.SortOptions

​

query ChecklistSearchQuery required

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

Fields of WorkbookSearchState

sort notebook.api.SortBy

​

query SearchNotebooksQuery required

​

template

Set type to "template".

template TemplateSearchState

​

Fields of TemplateSearchState

sort template.api.SortBy

Sort for templates view. Uses BE-supplied default if empty.

query SearchTemplatesQuery required

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

Fields of ProcedureSearchState

sort ProcedureSortOptions

​

query ProcedureSearchQuery required

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

Fields of ProcedureExecutionSearchState

sort ProcedureExecutionSortOptions

​

query ProcedureExecutionSearchQuery required

​

displayState DisplayState

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Fields of TableState

columnVisibility map of ColumnId to boolean

​

columnSizing map of ColumnId to integer

​

columnOrder array of string

​

columnPinning ColumnPinningState

​

metricColumns MetricColumns

​

index integer

​

Response

savedView SavedView

​

Fields of SavedView

metadata SavedViewMetadata

​

Fields of SavedViewMetadata

rid string (RID)

​

resourceType ResourceType

​

title string

​

symbol Symbol

​

color Color

​

isArchived boolean

​

createdAt string (date-time)

​

createdBy string (RID)

​

updatedAt string (date-time)

​

searchState SearchState

​

asset

Set type to "asset".

asset AssetSearchState

​

run

Set type to "run".

run RunSearchState

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

template

Set type to "template".

template TemplateSearchState

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

displayState DisplayState

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Request

curl

curl -X PUT "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "title": "<title>",
  "symbol": {
    "type": "symbol",
    "symbol": {
      "type": "icon",
      "icon": "<icon>"
    }
  },
  "color": {
    "type": "color",
    "color": {
      "type": "hexCode",
      "hexCode": "<hex code>"
    }
  },
  "searchState": {
    "type": "asset",
    "asset": {
      "query": {
        "type": "searchText",
        "searchText": "<search text>"
      }
    }
  },
  "displayState": {
    "type": "displayStateV1",
    "displayStateV1": {
      "columnVisibility": {
        "<key>": true
      },
      "columnSizing": {
        "<key>": 1
      },
      "columnOrder": [
        "<column id>"
      ],
      "columnPinning": {
        "left": [
          "<column id>"
        ],
        "right": [
          "<column id>"
        ]
      },
      "metricColumns": {
        "type": "asset",
        "asset": {
          "metricColumns": {
            "<key>": {
              "metadata": {
                "title": "<title>"
              },
              "timeRange": {
                "type": "mostRecentRun",
                "mostRecentRun": {}
              },
              "aggregation": "TOTAL_COUNT",
              "data": {
                "type": "event",
                "event": {
                  "type": "archived",
                  "archived": true
                }
              }
            }
          }
        }
      }
    }
  },
  "index": 1
}'

requests

import requests

response = requests.put(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "title": "<title>",
        "symbol": {"type": "symbol", "symbol": {"type": "icon", "icon": "<icon>"}},
        "color": {
            "type": "color",
            "color": {"type": "hexCode", "hexCode": "<hex code>"},
        },
        "searchState": {
            "type": "asset",
            "asset": {"query": {"type": "searchText", "searchText": "<search text>"}},
        },
        "displayState": {
            "type": "displayStateV1",
            "displayStateV1": {
                "columnVisibility": {"<key>": True},
                "columnSizing": {"<key>": 1},
                "columnOrder": ["<column id>"],
                "columnPinning": {"left": ["<column id>"], "right": ["<column id>"]},
                "metricColumns": {
                    "type": "asset",
                    "asset": {
                        "metricColumns": {
                            "<key>": {
                                "metadata": {"title": "<title>"},
                                "timeRange": {
                                    "type": "mostRecentRun",
                                    "mostRecentRun": {},
                                },
                                "aggregation": "TOTAL_COUNT",
                                "data": {
                                    "type": "event",
                                    "event": {"type": "archived", "archived": True},
                                },
                            },
                        },
                    },
                },
            },
        },
        "index": 1,
    },
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.put(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "title": "<title>",
        "symbol": {"type": "symbol", "symbol": {"type": "icon", "icon": "<icon>"}},
        "color": {
            "type": "color",
            "color": {"type": "hexCode", "hexCode": "<hex code>"},
        },
        "searchState": {
            "type": "asset",
            "asset": {"query": {"type": "searchText", "searchText": "<search text>"}},
        },
        "displayState": {
            "type": "displayStateV1",
            "displayStateV1": {
                "columnVisibility": {"<key>": True},
                "columnSizing": {"<key>": 1},
                "columnOrder": ["<column id>"],
                "columnPinning": {"left": ["<column id>"], "right": ["<column id>"]},
                "metricColumns": {
                    "type": "asset",
                    "asset": {
                        "metricColumns": {
                            "<key>": {
                                "metadata": {"title": "<title>"},
                                "timeRange": {
                                    "type": "mostRecentRun",
                                    "mostRecentRun": {},
                                },
                                "aggregation": "TOTAL_COUNT",
                                "data": {
                                    "type": "event",
                                    "event": {"type": "archived", "archived": True},
                                },
                            },
                        },
                    },
                },
            },
        },
        "index": 1,
    },
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.put(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "title": "<title>",
                "symbol": {
                    "type": "symbol",
                    "symbol": {"type": "icon", "icon": "<icon>"},
                },
                "color": {
                    "type": "color",
                    "color": {"type": "hexCode", "hexCode": "<hex code>"},
                },
                "searchState": {
                    "type": "asset",
                    "asset": {
                        "query": {"type": "searchText", "searchText": "<search text>"},
                    },
                },
                "displayState": {
                    "type": "displayStateV1",
                    "displayStateV1": {
                        "columnVisibility": {"<key>": True},
                        "columnSizing": {"<key>": 1},
                        "columnOrder": ["<column id>"],
                        "columnPinning": {
                            "left": ["<column id>"],
                            "right": ["<column id>"],
                        },
                        "metricColumns": {
                            "type": "asset",
                            "asset": {
                                "metricColumns": {
                                    "<key>": {
                                        "metadata": {"title": "<title>"},
                                        "timeRange": {
                                            "type": "mostRecentRun",
                                            "mostRecentRun": {},
                                        },
                                        "aggregation": "TOTAL_COUNT",
                                        "data": {
                                            "type": "event",
                                            "event": {
                                                "type": "archived",
                                                "archived": True,
                                            },
                                        },
                                    },
                                },
                            },
                        },
                    },
                },
                "index": 1,
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "savedView": {
    "metadata": {
      "rid": "<saved view rid>",
      "resourceType": "ASSET",
      "title": "<title>",
      "symbol": {
        "type": "icon",
        "icon": "<icon>"
      },
      "color": {
        "type": "hexCode",
        "hexCode": "<hex code>"
      },
      "isArchived": true,
      "createdAt": "2026-01-01T00:00:00Z",
      "createdBy": "<user rid>",
      "updatedAt": "2026-01-01T00:00:00Z"
    },
    "searchState": {
      "type": "asset",
      "asset": {
        "sort": {
          "isDescending": true,
          "field": "NAME",
          "sortKey": {
            "type": "field",
            "field": "NAME"
          }
        },
        "groupBy": [
          "<column id>"
        ],
        "query": {
          "type": "searchText",
          "searchText": "<search text>"
        }
      }
    },
    "displayState": {
      "type": "displayStateV1",
      "displayStateV1": {
        "columnVisibility": {
          "<key>": true
        },
        "columnSizing": {
          "<key>": 1
        },
        "columnOrder": [
          "<column id>"
        ],
        "columnPinning": {
          "left": [
            "<column id>"
          ],
          "right": [
            "<column id>"
          ]
        },
        "metricColumns": {
          "type": "asset",
          "asset": {
            "metricColumns": {
              "<key>": {
                "metadata": {
                  "title": "<title>",
                  "description": "<description>",
                  "symbol": {
                    "type": "icon",
                    "icon": "<icon>"
                  }
                },
                "timeRange": {
                  "type": "mostRecentRun",
                  "mostRecentRun": {}
                },
                "aggregation": "TOTAL_COUNT",
                "data": {
                  "type": "event",
                  "event": {
                    "type": "archived",
                    "archived": true
                  }
                },
                "style": {
                  "type": "RAW",
                  "value": [
                    {
                      "value": 1,
                      "color": "<color>",
                      "label": "<label>"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Batch get saved views

POST /scout/saved-views/v1/batch-get

Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.

Body

The body is an array of string (RID).

Response

savedViews array of SavedView

​

Fields of SavedView

metadata SavedViewMetadata

​

Fields of SavedViewMetadata

rid string (RID)

​

resourceType ResourceType

​

title string

​

symbol Symbol

​

color Color

​

isArchived boolean

​

createdAt string (date-time)

​

createdBy string (RID)

​

updatedAt string (date-time)

​

searchState SearchState

​

asset

Set type to "asset".

asset AssetSearchState

​

run

Set type to "run".

run RunSearchState

​

checklist

Set type to "checklist".

checklist ChecklistSearchState

​

workbook

Set type to "workbook".

workbook WorkbookSearchState

​

template

Set type to "template".

template TemplateSearchState

​

procedure

Set type to "procedure".

procedure ProcedureSearchState

​

procedureExecution

Set type to "procedureExecution".

procedureExecution ProcedureExecutionSearchState

​

displayState DisplayState

​

displayStateV1

Set type to "displayStateV1".

displayStateV1 TableState

​

Request

curl

curl -X POST "https://api.gov.nominal.io/api/scout/saved-views/v1/batch-get" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<saved view rid>"
]'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/batch-get",
    headers={"Authorization": "Bearer <api key>"},
    json=["<saved view rid>"],
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/batch-get",
    headers={"Authorization": "Bearer <api key>"},
    json=["<saved view rid>"],
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/batch-get",
            headers={"Authorization": "Bearer <api key>"},
            json=["<saved view rid>"],
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "savedViews": [
    {
      "metadata": {
        "rid": "<saved view rid>",
        "resourceType": "ASSET",
        "title": "<title>",
        "symbol": {
          "type": "icon",
          "icon": "<icon>"
        },
        "color": {
          "type": "hexCode",
          "hexCode": "<hex code>"
        },
        "isArchived": true,
        "createdAt": "2026-01-01T00:00:00Z",
        "createdBy": "<user rid>",
        "updatedAt": "2026-01-01T00:00:00Z"
      },
      "searchState": {
        "type": "asset",
        "asset": {
          "sort": {
            "isDescending": true,
            "field": "NAME",
            "sortKey": {
              "type": "field",
              "field": "NAME"
            }
          },
          "groupBy": [
            "<column id>"
          ],
          "query": {
            "type": "searchText",
            "searchText": "<search text>"
          }
        }
      },
      "displayState": {
        "type": "displayStateV1",
        "displayStateV1": {
          "columnVisibility": {
            "<key>": true
          },
          "columnSizing": {
            "<key>": 1
          },
          "columnOrder": [
            "<column id>"
          ],
          "columnPinning": {
            "left": [
              "<column id>"
            ],
            "right": [
              "<column id>"
            ]
          },
          "metricColumns": {
            "type": "asset",
            "asset": {
              "metricColumns": {
                "<key>": {
                  "metadata": {
                    "title": "<title>",
                    "description": "<description>",
                    "symbol": {
                      "type": "icon",
                      "icon": "<icon>"
                    }
                  },
                  "timeRange": {
                    "type": "mostRecentRun",
                    "mostRecentRun": {}
                  },
                  "aggregation": "TOTAL_COUNT",
                  "data": {
                    "type": "event",
                    "event": {
                      "type": "archived",
                      "archived": true
                    }
                  },
                  "style": {
                    "type": "RAW",
                    "value": [
                      {
                        "value": 1,
                        "color": "<color>",
                        "label": "<label>"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}

Search saved views

POST /scout/saved-views/v1/search

Searches for saved views using a nested query expression. Supports pagination.

Body

sort SavedViewSortOptions required

​

Fields of SavedViewSortOptions

isDescending boolean required

​

sortKey savedviews.api.SortKey required

Field to sort by.

field

Set type to "field".

field savedviews.api.SortField

​

Values of savedviews.api.SortField

TITLE

​

CREATED_AT

​

USER_DEFINED

​

pageSize integer

Defaults to 100. Will throw if larger than 1_000.

nextPageToken string

​

query SearchSavedViewsQuery required

​

and

Set type to "and".

and SearchSavedViewsQueryList

​

Fields of SearchSavedViewsQueryList

queries array of SearchSavedViewsQuery

​

or

Set type to "or".

or SearchSavedViewsQueryList

​

not

Set type to "not".

not SearchSavedViewsQuery

​

titleExactSubstringSearch

Set type to "titleExactSubstringSearch".

titleExactSubstringSearch string

​

resourceType

Set type to "resourceType".

resourceType ResourceType

​

Values of ResourceType

ASSET

​

RUN

​

WORKBOOK

​

CHECKLIST

​

TEMPLATE

​

PROCEDURE

​

PROCEDURE_EXECUTION

​

workspace

Set type to "workspace".

workspace string (RID)

​

archivedStatuses array of ArchivedStatus

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived assets in search.

Values of ArchivedStatus

NOT_ARCHIVED

​

ARCHIVED

​

Response

savedViews array of SavedViewMetadata

​

Fields of SavedViewMetadata

rid string (RID)

​

resourceType ResourceType

​

Values of ResourceType

ASSET

​

RUN

​

WORKBOOK

​

CHECKLIST

​

TEMPLATE

​

PROCEDURE

​

PROCEDURE_EXECUTION

​

title string

​

symbol Symbol

​

icon

Set type to "icon".

icon string

Icon name (e.g. castle)

emoji

Set type to "emoji".

emoji string

Emoji name (e.g. :castle:)

image

Set type to "image".

image string

Image url (e.g. https://example.com/image.png)

color Color

​

hexCode

Set type to "hexCode".

hexCode string

​

isArchived boolean

​

createdAt string (date-time)

​

createdBy string (RID)

​

updatedAt string (date-time)

​

nextPageToken string

​

Request

curl

curl -X POST "https://api.gov.nominal.io/api/scout/saved-views/v1/search" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "sort": {
    "isDescending": true,
    "sortKey": {
      "type": "field",
      "field": "TITLE"
    }
  },
  "query": {
    "type": "and",
    "and": {
      "queries": []
    }
  }
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/search",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "sort": {"isDescending": True, "sortKey": {"type": "field", "field": "TITLE"}},
        "query": {"type": "and", "and": {"queries": []}},
    },
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/search",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "sort": {"isDescending": True, "sortKey": {"type": "field", "field": "TITLE"}},
        "query": {"type": "and", "and": {"queries": []}},
    },
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/search",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "sort": {
                    "isDescending": True,
                    "sortKey": {"type": "field", "field": "TITLE"},
                },
                "query": {"type": "and", "and": {"queries": []}},
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "savedViews": [
    {
      "rid": "<saved view rid>",
      "resourceType": "ASSET",
      "title": "<title>",
      "symbol": {
        "type": "icon",
        "icon": "<icon>"
      },
      "color": {
        "type": "hexCode",
        "hexCode": "<hex code>"
      },
      "isArchived": true,
      "createdAt": "2026-01-01T00:00:00Z",
      "createdBy": "<user rid>",
      "updatedAt": "2026-01-01T00:00:00Z"
    }
  ],
  "nextPageToken": "<token>"
}

Archive saved view

POST /scout/saved-views/v1/{savedViewRid}/archive

Archives the specified saved view. Archived views are hidden from search.

Path parameters

savedViewRid string (RID) required

​

Response

No content (HTTP 204).

Request

curl

curl -X POST "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/archive" \
  -H "Authorization: Bearer <api key>"

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/archive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/archive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/archive",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Unarchive saved view

POST /scout/saved-views/v1/{savedViewRid}/unarchive

Restores archived saved view, making them discoverable in search again.

Path parameters

savedViewRid string (RID) required

​

Response

No content (HTTP 204).

Request

curl

curl -X POST "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/unarchive" \
  -H "Authorization: Bearer <api key>"

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/unarchive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/unarchive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/saved-views/v1/<saved view rid>/unarchive",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Errors

Errors shows how these errors are sent.

Each error’s errorName is SavedView: followed by its name below.

Status	Name	Notes
400	CannotChangeSavedViewResourceType
400	CannotUpdateArchivedSavedView
400	InvalidIndex
400	TooManyActiveSavedViews
404	SavedViewNotFoundError
404	SavedViewsNotFoundError
500	ResourceTypeAndSearchStateMismatch

Types

api.SearchQuery

Set type to the name of one of the other fields, and set only that field.

startTimeInclusive UtcTimestamp deprecated

Deprecated: Use startTime instead

startTime TimeframeFilter

​

endTimeInclusive UtcTimestamp deprecated

Deprecated: Use endTime instead

endTime TimeframeFilter

​

timeRange TimeRangeFilter

​

createdAt TimeframeFilter

​

exactMatch string

Performs case insensitive exact substring match search on the title.

searchText string

​

asset string (RID) deprecated

Deprecated: Use getRunsByAsset rather than text-based search

assets run.api.AssetsFilter

​

isSingleAsset boolean

Search for either only single-asset runs (true), or only multi-asset runs (false).

label string deprecated

Deprecated: use labels instead

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties

propertyKey string

Matches runs that have a property with this key, regardless of value.

properties PropertiesFilter

​

numericProperty NumericPropertyPredicate

Matches runs using a numeric property comparison.

numericPropertyRange NumericPropertyRangePredicate

Matches runs using an inclusive numeric property range.

dataSourceSeriesTag DataSourceSeriesTag

​

dataSourceRefName string

​

dataSource DataSource deprecated

Deprecated: Use dataSourceRefName, rather than searching directly by DataSource.

runNumber integer (int64)

​

runPrefix string

​

checkAlertStatesFilter CheckAlertStatesFilter

Search for runs where its aggregated check alert satisfy a given operator and threshold.

archived boolean

​

and array of api.SearchQuery

​

or array of api.SearchQuery

​

not api.SearchQuery

​

workspace string (RID)

​

lockStatus LockStatus

​

datasetRids array of string (RID)

Applied as a post-filter to the page returned by unified search. A run matches when any requested dataset is in its data scopes. At most 10 dataset RIDs may be provided.

ArchivedStatus

NOT_ARCHIVED

​

ARCHIVED

​

asset.api.SortKey

Set type to the name of one of the other fields, and set only that field.

field AssetSortField

​

property asset.api.SortProperty

​

numericProperty asset.api.SortProperty

Sort by a numeric property value. String-valued and missing properties are null and always sort last.

asset.api.SortProperty

name string required

​

AssetMetricColumn

metadata MetricColumnMetadata required

​

timeRange AssetMetricColumnTimeRange required

​

aggregation MetricColumnAggregation required

​

data MetricColumnData required

​

style MetricColumnStyle

​

AssetMetricColumns

metricColumns map of ColumnId to AssetMetricColumn

​

AssetMetricColumnTimeRange

Set type to the name of one of the other fields, and set only that field.

mostRecentRun MostRecentRun

​

custom CustomTimeframeFilter

​

preset PresetTimeframeFilter

​

AssetSearchState

sort AssetSortOptions

​

groupBy array of string

​

query SearchAssetsQuery required

​

AssetsFilterOperator

OR

​

AND

​

AssetSortField

NAME

​

CREATED_AT

​

MOST_RECENT_RUN_START

​

AssetSortOptions

isDescending boolean required

​

field AssetSortField deprecated

Deprecated: use SortKey with SortField union type instead

sortKey asset.api.SortKey

Field to sort by. Includes both field and property-based sorting. Must be supplied if field is not provided separately.

AssetTypesFilter

Matches an asset when any of its types is in assetTypes.

assetTypes array of string (RID)

​

AssigneesFilter

operator SetOperator required

​

assignees array of string (RID)

​

CheckAlertState

Set type to the name of one of the other fields, and set only that field.

pendingReview PendingReviewAlertState

​

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

closedWithIgnore ClosedWithIgnoreAlertState

​

CheckAlertStatesFilter

checkAlertState CheckAlertState required

​

operator Operator required

​

threshold integer (int64) required

​

ChecklistSearchQuery

Set type to the name of one of the other fields, and set only that field.

and array of ChecklistSearchQuery

​

or array of ChecklistSearchQuery

​

searchText string

​

label string deprecated

Deprecated: use labels instead

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties

properties PropertiesFilter

​

authorRid string (RID)

​

assigneeRid string (RID)

​

isPublished boolean

​

not ChecklistSearchQuery

​

workspace string (RID)

​

authorIsCurrentUser boolean

​

authorRids array of string (RID)

​

isArchived boolean

​

ChecklistSearchState

sort checks.api.SortOptions

​

query ChecklistSearchQuery required

​

checks.api.SortField

CREATED_AT

​

LAST_USED

​

UPDATED_AT

​

checks.api.SortOptions

isDescending boolean required

​

field checks.api.SortField required

​

ClosedWithFurtherActionAlertState

comment string required

​

closedBy string (RID) required

​

ClosedWithIgnoreAlertState

comment string required

​

closedBy string (RID) required

​

Color

Set type to the name of one of the other fields, and set only that field.

hexCode string

​

ColumnPinningState

left array of string

​

right array of string

​

CustomTimeframeFilter

startTime UtcTimestamp

​

endTime UtcTimestamp

​

DataReviewChecksFilter

dataReviewChecks array of string (RID)

​

DataReviewsFilter

dataReviews array of string (RID)

​

DataSource

Set type to the name of one of the other fields, and set only that field.

dataset string (RID)

​

connection string (RID)

​

logSet string (RID)

​

video string (RID)

​

spatial string (RID)

​

DataSourceSeriesTag

name string required

​

value string required

​

DisplayState

Set type to the name of one of the other fields, and set only that field.

displayStateV1 TableState

​

Empty

An empty JSON object, {}.

event.AssetsFilter

operator SetOperator required

​

assets array of string (RID)

​

event.SearchQuery

Set type to the name of one of the other fields, and set only that field.

archived boolean

​

searchText string

Search text to perform fuzzy searching against.

exactMatch string

Search text to perform exact matching against on the event name and description.

after Timestamp

Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

before Timestamp

Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

advancedTimeFilter EventTimeFilter

​

asset string (RID) deprecated

Deprecated: use assetRids

assets event.AssetsFilter

​

template string (RID)

​

workbook string (RID)

​

dataReview string (RID) deprecated

Deprecated: use dataReviews instead

dataReviews DataReviewsFilter

​

originType SearchEventOriginType deprecated

Deprecated: use originTypes instead

originTypes OriginTypesFilter

​

dataReviewCheck string (RID) deprecated

Deprecated: use dataReviewChecks instead

dataReviewChecks DataReviewChecksFilter

​

dispositionStatus EventDispositionStatus deprecated

Deprecated: use dispositionStatuses instead

dispositionStatuses array of EventDispositionStatus

​

priority Priority deprecated

Deprecated: use priorities instead

priorities array of Priority

​

assignee string (RID) deprecated

Deprecated: use assignees instead

assignees AssigneesFilter

​

eventType EventType deprecated

Deprecated: use eventTypes instead

eventTypes array of EventType

​

createdBy string (RID)

​

createdByAnyOf array of string (RID)

​

label string deprecated

Deprecated: use labels instead

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties instead

properties PropertiesFilter

​

and array of event.SearchQuery

​

or array of event.SearchQuery

​

not event.SearchQuery

​

workspace string (RID)

​

procedure string (RID)

​

procedureExecution string (RID)

​

stepId string

​

streamingChecklist string (RID)

Filters to events created from a checklist executing in streaming. Use assets to further filter to a specific streaming checklist instance.

streamingCheck string (RID)

Filters to events created from the check of a checklist executing in streaming. Use assets to further filter to a specific streaming checklist instance.

numericProperty NumericPropertyPredicate

Matches events using a numeric property comparison.

numericPropertyRange NumericPropertyRangePredicate

Matches events using an inclusive numeric property range.

EventDispositionStatus

PENDING_REVIEW

​

CLOSED_IGNORED

​

CLOSED_REQUIRES_FURTHER_ACTION

​

NO_DISPOSITION

​

EventTimeFilter

timestamp Timestamp required

​

timestampCondition EventTimeFilterCondition required

​

EventTimeFilterCondition

START_TIME_BEFORE_INCLUSIVE

​

START_TIME_BEFORE_EXCLUSIVE

​

START_TIME_AFTER_INCLUSIVE

​

START_TIME_AFTER_EXCLUSIVE

​

END_TIME_BEFORE_INCLUSIVE

​

END_TIME_BEFORE_EXCLUSIVE

​

END_TIME_AFTER_INCLUSIVE

​

END_TIME_AFTER_EXCLUSIVE

​

EventType

INFO

​

FLAG

​

ERROR

​

SUCCESS

​

LabelsFilter

operator SetOperator required

​

labels array of string

​

LockStatus

Whether the run is locked, preventing any changes from being made.

LOCKED

​

UNLOCKED

​

MetricColumnAggregation

TOTAL_COUNT

​

TOTAL_DURATION

​

MetricColumnData

Set type to the name of one of the other fields, and set only that field.

event event.SearchQuery

​

MetricColumnMetadata

title string required

​

description string

​

symbol Symbol

​

MetricColumns

Set type to the name of one of the other fields, and set only that field.

asset AssetMetricColumns

​

MetricColumnStyle

type MetricColumnThresholdType required

​

value array of MetricColumnThreshold

​

MetricColumnThreshold

value number required

​

color string required

​

label string

​

MetricColumnThresholdType

RAW

​

BAR

​

MostRecentRun

An empty JSON object, {}.

notebook.api.AssetsFilter

for an exact match, use the exactAssetRids filter

operator SetOperator required

​

assets array of string (RID)

​

notebook.api.SortBy

isDescending boolean required

​

field notebook.api.SortByField required

​

notebook.api.SortByField

NAME

​

CREATED_AT

​

UPDATED_AT

​

NotebookType

The kind of workbook. Persisted on metadata, so it is readable without loading content and filterable through notebookTypes.

WORKBOOK

​

COMPARISON_WORKBOOK

​

ANALYST_EPHEMERAL_WORKBOOK

​

REPORT

​

NotebookTypesFilter

returns notebooks that match any of the provided notebook types

types array of NotebookType

​

NumericPropertyPredicate

Matches resources that have a numeric value for the named property and whose value satisfies the operator. NEQ excludes resources that lack the property or store a string value under the same name.

name string required

​

value number required

​

operator PropertyComparisonOperator required

​

NumericPropertyRangeOperator

BETWEEN

​

NOT_BETWEEN

​

NumericPropertyRangePredicate

Inclusive range on a numeric property. At least one bound is required. BETWEEN: min <= x <= max. An absent bound is unbounded on that side. NOT_BETWEEN: x < min OR x > max. An absent bound drops that side. Both operators require a numeric value for name. Missing properties and string values never match. Bounds are closed [min, max] to match the number chip (is between / is not between), not half-open.

name string required

​

min number

​

max number

​

operator NumericPropertyRangeOperator required

​

Operator

LEQ

​

LT

​

GEQ

​

GT

​

EQ

​

OriginTypesFilter

operator SetOperator required

​

originTypes array of SearchEventOriginType

​

PendingReviewAlertState

An empty JSON object, {}.

PresetTimeframeDuration

ALL_TIME

​

LAST_DAY

​

LAST_WEEK

​

LAST_MONTH

​

LAST_YEAR

​

PresetTimeframeFilter

duration PresetTimeframeDuration required

​

Priority

P0

​

P1

​

P2

​

P3

​

P4

​

ProcedureExecutionAssetsFilter

assetRids array of string (RID)

​

operator AssetsFilterOperator required

​

ProcedureExecutionProgressStatus

NOT_STARTED

​

IN_PROGRESS

​

FINISHED

​

ABORTED

​

ProcedureExecutionSearchQuery

Set type to the name of one of the other fields, and set only that field.

searchText string

​

label string

​

property Property

​

and array of ProcedureExecutionSearchQuery

​

or array of ProcedureExecutionSearchQuery

​

workspace string (RID)

​

procedureRid string (RID)

​

commitId string

​

createdBy string (RID)

​

progressStatus ProcedureExecutionProgressStatus

​

assetsFilter ProcedureExecutionAssetsFilter

​

isArchived boolean

​

ProcedureExecutionSearchState

sort ProcedureExecutionSortOptions

​

query ProcedureExecutionSearchQuery required

​

ProcedureExecutionSortField

CREATED_AT

​

STARTED_AT

​

FINISHED_AT

​

UPDATED_AT

​

ProcedureExecutionSortOptions

isDescending boolean

​

sortField ProcedureExecutionSortField required

​

ProcedureSearchQuery

Set type to the name of one of the other fields, and set only that field.

searchText string

​

label string

​

property Property

​

and array of ProcedureSearchQuery

​

or array of ProcedureSearchQuery

​

workspace string (RID)

​

createdBy string (RID)

​

isArchived boolean

​

ProcedureSearchState

sort ProcedureSortOptions

​

query ProcedureSearchQuery required

​

ProcedureSortField

NAME

​

CREATED_AT

​

UPDATED_AT

​

ProcedureSortOptions

isDescending boolean

​

sortField ProcedureSortField

​

PropertiesFilter

name string required

​

values array of string

​

Property

name string required

​

value string required

​

PropertyComparisonOperator

EQ

​

NEQ

​

GT

​

GTE

​

LT

​

LTE

​

ResourceType

ASSET

​

RUN

​

WORKBOOK

​

CHECKLIST

​

TEMPLATE

​

PROCEDURE

​

PROCEDURE_EXECUTION

​

run.api.AssetsFilter

returns runs that match any of the provided assets.

assets array of string (RID)

​

run.api.SortField

NAME

​

ID

​

CREATED_AT

​

START_TIME

​

END_TIME

​

PENDING_CHECK_ALERTS

​

run.api.SortKey

Set type to the name of one of the other fields, and set only that field.

field run.api.SortField

​

property run.api.SortProperty

Sort by a property value. Requires a property name, and will always sort null values last.

numericProperty run.api.SortProperty

Sort by a numeric property value. String-valued and missing properties are null and always sort last.

run.api.SortOptions

isDescending boolean required

​

field run.api.SortField deprecated

Deprecated: use SortKey with SortField union type instead

sortKey run.api.SortKey

Field to sort by. Includes both field and property-based sorting.

additionalSortKeys array of SortKeyWithDirection

Optional secondary sort keys for tiebreaking. Applied in order after the primary sortKey. Each entry specifies its own sort key and direction. If empty or absent, ties are broken by UUID only.

run.api.SortProperty

name string required

​

RunSearchState

sort run.api.SortOptions

​

groupBy array of string

​

query api.SearchQuery required

​

RunsFilter

operator SetOperator required

​

runs array of string (RID)

​

SavedView

metadata SavedViewMetadata required

​

searchState SearchState required

​

displayState DisplayState required

​

SavedViewMetadata

rid string (RID) required

​

resourceType ResourceType required

​

title string required

​

symbol Symbol

​

color Color

​

isArchived boolean required

​

createdAt string (date-time) required

​

createdBy string (RID) required

​

updatedAt string (date-time) required

​

savedviews.api.SortField

TITLE

​

CREATED_AT

​

USER_DEFINED

​

savedviews.api.SortKey

Set type to the name of one of the other fields, and set only that field.

field savedviews.api.SortField

​

SavedViewSortOptions

isDescending boolean required

​

sortKey savedviews.api.SortKey required

Field to sort by.

SearchAssetsQuery

Set type to the name of one of the other fields, and set only that field.

searchText string

​

exactSubstring string

An case-insensitive substring match of the title or description of the asset.

label string deprecated

Deprecated: use labels instead

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties

propertyKey string

Matches assets that have a property with this key, regardless of value.

properties PropertiesFilter

​

numericProperty NumericPropertyPredicate

Matches assets using a numeric property comparison.

numericPropertyRange NumericPropertyRangePredicate

Matches assets using an inclusive numeric property range.

typeRid string (RID) deprecated

Deprecated: use assetTypes

assetTypes AssetTypesFilter

​

isStaged boolean deprecated

Deprecated: staged assets are no longer returned in the search endpoint

archived boolean

​

and array of SearchAssetsQuery

​

or array of SearchAssetsQuery

​

not SearchAssetsQuery

​

workspace string (RID)

​

SearchEventOriginType

WORKBOOK

​

TEMPLATE

​

API

​

DATA_REVIEW

​

PROCEDURE

​

STREAMING_CHECKLIST

​

SearchNotebooksQuery

Set type to the name of one of the other fields, and set only that field.

and array of SearchNotebooksQuery

​

or array of SearchNotebooksQuery

​

not SearchNotebooksQuery

​

exactMatch string

Performs case insensitive exact match search on the title.

searchText string

​

label string deprecated

Deprecated: use labels

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties

properties PropertiesFilter

​

assetRid string (RID) deprecated

Deprecated: use assetRids

assetRids notebook.api.AssetsFilter

​

exactAssetRids array of string (RID)

Requires the set of assets in the query to exactly match the set of assets in the notebook. To do a partial match, use an assetRids query.

authorRid string (RID)

​

runRid string (RID) deprecated

Deprecated: use runRids

runRids RunsFilter

​

notebookType NotebookType deprecated

Deprecated: use notebook types

notebookTypes NotebookTypesFilter

​

draftState boolean

​

archived boolean

​

workspace string (RID)

​

authorIsCurrentUser boolean

​

authorRids array of string (RID)

​

SearchSavedViewsQuery

Set type to the name of one of the other fields, and set only that field.

and SearchSavedViewsQueryList

​

or SearchSavedViewsQueryList

​

not SearchSavedViewsQuery

​

titleExactSubstringSearch string

​

resourceType ResourceType

​

workspace string (RID)

​

SearchSavedViewsQueryList

queries array of SearchSavedViewsQuery

​

SearchState

Set type to the name of one of the other fields, and set only that field.

asset AssetSearchState

​

run RunSearchState

​

checklist ChecklistSearchState

​

workbook WorkbookSearchState

​

template TemplateSearchState

​

procedure ProcedureSearchState

​

procedureExecution ProcedureExecutionSearchState

​

SearchTemplatesQuery

Set type to the name of one of the other fields, and set only that field.

and array of SearchTemplatesQuery

​

or array of SearchTemplatesQuery

​

not SearchTemplatesQuery

​

exactMatch string

Performs case insensitive exact match search on the title.

searchText string

Searches title and description only

label string deprecated

Deprecated: use labels instead

labels LabelsFilter

​

property Property deprecated

Deprecated: use properties

properties PropertiesFilter

​

createdBy string (RID)

​

isArchived boolean

​

isPublished boolean

​

workspace string (RID)

​

authorIsCurrentUser boolean

​

authorRids array of string (RID)

​

SetOperator

AND

​

OR

​

SortKeyWithDirection

sortKey run.api.SortKey required

​

isDescending boolean required

​

Symbol

Set type to the name of one of the other fields, and set only that field.

icon string

Icon name (e.g. castle)

emoji string

Emoji name (e.g. :castle:)

image string

Image url (e.g. https://example.com/image.png)

TableState

columnVisibility map of ColumnId to boolean

​

columnSizing map of ColumnId to integer

​

columnOrder array of string

​

columnPinning ColumnPinningState

​

metricColumns MetricColumns

​

template.api.SortBy

isDescending boolean required

​

field template.api.SortByField required

​

template.api.SortByField

UPDATED_AT is an alias for EDITED_AT.

NAME

​

CREATED_AT

​

UPDATED_AT

​

EDITED_AT

​

TemplateSearchState

sort template.api.SortBy

Sort for templates view. Uses BE-supplied default if empty.

query SearchTemplatesQuery required

​

TimeframeFilter

Set type to the name of one of the other fields, and set only that field.

custom CustomTimeframeFilter

​

preset PresetTimeframeFilter

​

TimeRangeFilter

searches for runs that have at least some intersection with the specified range.

start UtcTimestamp

​

end UtcTimestamp

​

Timestamp

Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.

This legacy nanosecond precision timestamp type is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion.

seconds integer (int64) required

​

nanos integer (int64) required

​

UpdateColor

Set type to the name of one of the other fields, and set only that field.

color Color

​

clearColor Empty

​

UpdateSymbol

Set type to the name of one of the other fields, and set only that field.

symbol Symbol

​

clearSymbol Empty

​

UtcTimestamp

secondsSinceEpoch integer (int64) required

​

offsetNanoseconds integer (int64)

​

WorkbookSearchState

sort notebook.api.SortBy

​

query SearchNotebooksQuery required

​

Page design based on Scalar, MIT License.