Skip to content

DataClipState ​

Type: Object

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.

Fields ​

NameTypeArgsDescriptionDeprecated
createdAtString!ISO-8601 timestamp of when the clip was first saved.
creatorIdUserID!TypeID of the user who created the clip (e.g. "usr_01K…"). Not reassigned on update.
csvExportPathString!Relative path for CSV export (combine with server base URL)
descriptionStringOptional free-text note explaining what the clip reports; null when unset. At most 1000 characters.
idDataClipID!TypeID of this data clip (e.g. "dcl_01K…").
jsonExportPathString!Relative path for JSON export (combine with server base URL)
nameString!Human-readable label for the clip, shown in listings. Required and non-empty.
queryStringString!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.
updatedAtString!ISO-8601 timestamp of the clip's last change, including a share-token roll.

Connect machines, automate workflows, and build custom apps for print production.