v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB

data-clips

Create

Creates a new DataClip.

post/data-clips

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

namestring required

The name of the DataClip.

descriptionstring

A description of the DataClip.

sourceSheetIdstring required

Sheet ID

collaboratorsstring[]

The list of collaborators.

sharedLinkAccess'public' | 'restricted'

Response

Response with status 200

idstring required

Data Clip ID

namestring required

The name of the DataClip.

descriptionstring

A description of the DataClip.

sourceSheetIdstring required

Sheet ID

clipSheetIdstring required

Sheet ID

workbookIdstring required

The ID of the workbook.

statusstring required

The status of the DataClip.

createdBystring required

The user who created the DataClip.

mergedAtstring date-time

The date when the DataClip was merged.

deletedAtstring date-time

The date when the DataClip was deleted.

updatedAtstring date-time required

The date when the DataClip was updated.

createdAtstring date-time required

The date when the DataClip was created.

guestLinkUrlstring

A URL for guests to access the DataClip.

accessTokenstring

A signed token associated with the guest link.

sharedLinkAccessstring

Indicates the shared link access level, public or restricted