Views SDK Reference

Views

List Views

List visible saved views

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.views.list()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.views.list();

  console.log(result);
}

run();

Show Parameters

{
    "limit": Optional[int],
    "starting_after": Optional[str],
    "ending_before": Optional[str],
    "page": Optional[str],
}

{
  limit?: number;
  startingAfter?: string;
  endingBefore?: string;
  page?: string;
}

Show Response

{
    "data": [{  # optional
        "id": Optional[str],
        "display_name": Optional[str],
        "description": Optional[str],
        "workspace_id": Optional[str],
        "page": Optional[str],
        "filter_by": Optional[str],
        "columns": List[str],  # optional
        "column_labels": Dict[str, str],  # optional
        "is_default": Optional[bool],
        "private_for_ids": List[str],  # optional
        "version": Optional[int],
        "created_by_id": Optional[str],
        "updated_by_id": Optional[str],
        "created_at": str,  # optional
        "updated_at": str,  # optional
    }],
    "has_more": Optional[bool],
}

{
  data?: {
    id?: string;
    displayName?: string;
    description?: string;
    workspaceId?: string;
    page?: string;
    filterBy?: string;
    columns?: string[];
    columnLabels?: Record<string, string>;
    isDefault?: boolean;
    privateForIds?: string[];
    version?: number;
    createdById?: string;
    updatedById?: string;
    createdAt?: Date;
    updatedAt?: Date;
  }[];
  hasMore?: boolean;
}

Create a View

Create a saved view

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.views.create(display_name="Saved logs", page="logs")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.views.create({
    displayName: "Saved logs",
    page: "logs",
  });

  console.log(result);
}

run();

Show Parameters

{
    "display_name": Optional[str],
    "description": Optional[str],
    "page": Optional[str],
    "filter_by": Optional[str],
    "columns": List[str],  # optional
    "column_labels": Dict[str, str],  # optional
    "is_default": Optional[bool],
    "is_private": Optional[bool],
    "version": Optional[int],
}

{
  displayName?: string;
  description?: string;
  page?: string;
  filterBy?: string;
  columns?: string[];
  columnLabels?: Record<string, string>;
  isDefault?: boolean;
  isPrivate?: boolean;
  version?: number;
}

Show Response

{
    "view": {  # optional
        "id": Optional[str],
        "display_name": Optional[str],
        "description": Optional[str],
        "workspace_id": Optional[str],
        "page": Optional[str],
        "filter_by": Optional[str],
        "columns": List[str],  # optional
        "column_labels": Dict[str, str],  # optional
        "is_default": Optional[bool],
        "private_for_ids": List[str],  # optional
        "version": Optional[int],
        "created_by_id": Optional[str],
        "updated_by_id": Optional[str],
        "created_at": str,  # optional
        "updated_at": str,  # optional
    },
}

{
  view?: {
    id?: string;
    displayName?: string;
    description?: string;
    workspaceId?: string;
    page?: string;
    filterBy?: string;
    columns?: string[];
    columnLabels?: Record<string, string>;
    isDefault?: boolean;
    privateForIds?: string[];
    version?: number;
    createdById?: string;
    updatedById?: string;
    createdAt?: Date;
    updatedAt?: Date;
  };
}

Retrieve a View

Retrieve a saved view

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.views.get(view_id="<id>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.views.get({
    viewId: "<id>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "view_id": str,  # required
}

{
  viewId: string;  // required
}

Show Response

{
    "view": {  # optional
        "id": Optional[str],
        "display_name": Optional[str],
        "description": Optional[str],
        "workspace_id": Optional[str],
        "page": Optional[str],
        "filter_by": Optional[str],
        "columns": List[str],  # optional
        "column_labels": Dict[str, str],  # optional
        "is_default": Optional[bool],
        "private_for_ids": List[str],  # optional
        "version": Optional[int],
        "created_by_id": Optional[str],
        "updated_by_id": Optional[str],
        "created_at": str,  # optional
        "updated_at": str,  # optional
    },
}

{
  view?: {
    id?: string;
    displayName?: string;
    description?: string;
    workspaceId?: string;
    page?: string;
    filterBy?: string;
    columns?: string[];
    columnLabels?: Record<string, string>;
    isDefault?: boolean;
    privateForIds?: string[];
    version?: number;
    createdById?: string;
    updatedById?: string;
    createdAt?: Date;
    updatedAt?: Date;
  };
}

Delete a View

Delete a saved view

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.views.delete(view_id="<id>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.views.delete({
    viewId: "<id>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "view_id": str,  # required
}

{
  viewId: string;  // required
}

Update a View

Update a saved view

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.views.update(view_id="<id>", display_name="Saved logs")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.views.update({
    viewId: "<id>",
    updateViewRequest: {
      displayName: "Saved logs",
    },
  });

  console.log(result);
}

run();

Show Parameters

{
    "view_id": str,  # required
    "display_name": Optional[str],
    "description": Optional[str],
    "filter_by": Optional[str],
    "columns": List[str],  # optional
    "column_labels": Dict[str, str],  # optional
    "is_default": Optional[bool],
    "is_private": Optional[bool],
    "version": Optional[int],
    "update_mask": Optional[str],
}

{
  viewId: string;  // required
  updateViewRequest: {  // required
    displayName?: string;
    description?: string;
    filterBy?: string;
    columns?: string[];
    columnLabels?: Record<string, string>;
    isDefault?: boolean;
    isPrivate?: boolean;
    version?: number;
    updateMask?: string;
  };
}

Show Response

{
    "view": {  # optional
        "id": Optional[str],
        "display_name": Optional[str],
        "description": Optional[str],
        "workspace_id": Optional[str],
        "page": Optional[str],
        "filter_by": Optional[str],
        "columns": List[str],  # optional
        "column_labels": Dict[str, str],  # optional
        "is_default": Optional[bool],
        "private_for_ids": List[str],  # optional
        "version": Optional[int],
        "created_by_id": Optional[str],
        "updated_by_id": Optional[str],
        "created_at": str,  # optional
        "updated_at": str,  # optional
    },
}

{
  view?: {
    id?: string;
    displayName?: string;
    description?: string;
    workspaceId?: string;
    page?: string;
    filterBy?: string;
    columns?: string[];
    columnLabels?: Record<string, string>;
    isDefault?: boolean;
    privateForIds?: string[];
    version?: number;
    createdById?: string;
    updatedById?: string;
    createdAt?: Date;
    updatedAt?: Date;
  };
}

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Management APIs

Views

List Views

Create a View

Retrieve a View

Delete a View

Update a View

​Views

​List Views

​Create a View

​Retrieve a View

​Delete a View

​Update a View

Views

List Views

Create a View

Retrieve a View

Delete a View

Update a View