← All resources

Resource

data_clip

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.

GraphQL reference →

Configuration

nameString!Required

Label for the new clip. Required and non-empty.

descriptionStringOptional

Optional note about what the clip reports (max 1000 characters).

queryStringString!Required

MicroSQL query the clip runs. Required and non-empty.

Read-only values

Show values
idDataClipID!Read only

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

computed by the platform

shareTokenString!Read only

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.

computed by the platform

creatorIdUserID!Read only

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

References service_account

computed by the platform

jsonExportPathString!Read only

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

computed by the platform

csvExportPathString!Read only

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

computed by the platform

createdAtString!Read only

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

computed by the platform

updatedAtString!Read only

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

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.