Skip to content

DoCurious API Reference / types / DataExportRequest

Interface: DataExportRequest

Defined in: types/user.types.ts:425

Tracks a GDPR/CCPA data export request initiated by the user.

Remarks

The export is generated asynchronously. Once status reaches 'completed', a time-limited downloadUrl is provided. Media attachments (images, videos) are included only when includeMedia is true, which significantly increases file size.

Extends

Properties

completedAt?

optional completedAt: string

Defined in: types/user.types.ts:433


createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt


downloadUrl?

optional downloadUrl: string

Defined in: types/user.types.ts:430

Signed URL for downloading the export archive; available only when status is 'completed'


expiresAt?

optional expiresAt: string

Defined in: types/user.types.ts:432

ISO datetime after which downloadUrl is no longer valid


format

format: "json" | "csv"

Defined in: types/user.types.ts:435

Output format of the exported data


id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id


includeMedia

includeMedia: boolean

Defined in: types/user.types.ts:437

Whether to bundle uploaded images and media files in the export


requestedAt

requestedAt: string

Defined in: types/user.types.ts:427


status

status: "pending" | "completed" | "processing" | "failed"

Defined in: types/user.types.ts:428


updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt


userId

userId: string

Defined in: types/user.types.ts:426

DoCurious Platform Documentation