ListResponse[SemanticTemplateResponse]

Paginated response containing Semantic Template Response records. The required field is items.

items object[]required

List of resource items

Array [

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

URL-safe short handle

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

type object

Subtype within category

anyOf

• string
• null

string

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

description object

Resource description

anyOf

• string
• null

string

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

Default value: []

created_at object

Creation timestamp (Unix ms)

anyOf

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required

avatar_url object

anyOf

• string
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

templates object[]

Array [

nameName (string)required

Stable name of the computation template within its template group.

description object

Human-readable explanation of the computation.

anyOf

• string
• null

string

questionsstring[]required

Example questions used to match requests to this template.

Possible values: >= 1

slots object[]

Input slots shared by every query in the template.

Array [

nameName (string)required

kindKind (string)

Possible values: [string, number, value, list]

Default value: string

description object

anyOf

• string
• null

string

requiredRequired (boolean)

Default value: true

defaultDefault

]

queries object[]required

Named queries whose results are passed to the computation code.

Possible values: >= 1

Array [

nameName (string)required

table_idTable Id (string)required

toolTool (string)

Possible values: [metrics, rows]

Default value: metrics

query objectrequired

property name*any

]

codeCode (string)required

Code that combines the named query results into the template output.

]

itemItem (string)requireddeprecated

]

next_cursor object

Cursor for next page

anyOf

• string
• null

string

has_moreHas More (boolean)

Whether more pages exist

Default value: false

ListResponse[SemanticTemplateResponse]

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "alias": "string",
      "category": "string",
      "type": "string",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "markings": [
        "string"
      ],
      "created_at": 0,
      "updated_at": 0,
      "owners": [
        {
          "id": "string",
          "type": "user",
          "display_name": "string",
          "avatar_url": "string",
          "avatar_config": {},
          "email": "user@example.com"
        }
      ],
      "my_share_scope": "owner",
      "templates": [
        {
          "name": "string",
          "description": "string",
          "questions": [
            "string"
          ],
          "slots": [
            {
              "name": "string",
              "kind": "string",
              "description": "string",
              "required": true
            }
          ],
          "queries": [
            {
              "name": "string",
              "table_id": "string",
              "tool": "metrics",
              "query": {}
            }
          ],
          "code": "string"
        }
      ]
    }
  ],
  "next_cursor": "string",
  "has_more": false
}