← API reference
CANONICAL TYPE REFERENCE

DataClipState

A saved MicroSQL reporting query that can be re-run in-app or exported publicly as JSON/CSV/NDJSON via its share token. Scoped to a single tenant.

TypeID of this data clip (e.g. "dcl_01K…").

nameString!

Human-readable label for the clip, shown in listings. Required and non-empty.

Optional free-text note explaining what the clip reports; null when unset. At most 1000 characters.

The saved MicroSQL query the clip runs. Executed against the tenant's reporting schema with tenant isolation injected at execution time.

shareTokenString!

Secret 64-hex-character (256-bit) token that grants unauthenticated access to this clip's export endpoints. Anyone holding it can read the clip's results, so treat it as a credential; rollDataClipShareToken replaces it and invalidates old links.

TypeID of the user who created the clip (e.g. "usr_01K…"). Not reassigned on update.

Relative path for JSON export (combine with server base URL)

Relative path for CSV export (combine with server base URL)

createdAtString!

ISO-8601 timestamp of when the clip was first saved.

updatedAtString!

ISO-8601 timestamp of the clip's last change, including a share-token roll.

View exact SDL
"""
A saved MicroSQL reporting query that can be re-run in-app or exported publicly as JSON/CSV/NDJSON via its share token. Scoped to a single tenant.
"""
type DataClipState @iac_resource(name: "data_clip") @iac_ops(create: "createDataClip", read: "getDataClip", update: "updateDataClip", delete: "deleteDataClip") {
  """TypeID of this data clip (e.g. "dcl_01K…")."""
  id: DataClipID! @iac_identity(assignedBy: SERVER) @iac_computed
  """
  Human-readable label for the clip, shown in listings. Required and non-empty.
  """
  name: String!
  """
  Optional free-text note explaining what the clip reports; null when unset. At most 1000 characters.
  """
  description: String
  """
  The saved MicroSQL query the clip runs. Executed against the tenant's reporting schema with tenant isolation injected at execution time.
  """
  queryString: String! @iac_artifact(language: SQL)
  """
  Secret 64-hex-character (256-bit) token that grants unauthenticated access to this clip's export endpoints. Anyone holding it can read the clip's results, so treat it as a credential; `rollDataClipShareToken` replaces it and invalidates old links.
  """
  shareToken: String! @iac_computed
  """
  TypeID of the user who created the clip (e.g. "usr_01K…"). Not reassigned on update.
  """
  creatorId: UserID! @iac_ref(resource: "service_account") @iac_computed
  """Relative path for JSON export (combine with server base URL)"""
  jsonExportPath: String! @iac_computed
  """Relative path for CSV export (combine with server base URL)"""
  csvExportPath: String! @iac_computed
  """ISO-8601 timestamp of when the clip was first saved."""
  createdAt: String! @iac_computed
  """
  ISO-8601 timestamp of the clip's last change, including a share-token roll.
  """
  updatedAt: String! @iac_computed
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.