data-exports

Create data_export

Create a new data_export in PENDING and enqueue the build worker.

Pass project_ids to scope the export to those projects (list candidates via GET /v1/projects); omit it for an org-wide export, which is capped at a 6-month range. Any project the API key's org doesn't own returns 404 — same as an unknown one, and the whole request is rejected rather than exporting the subset that resolved.

The build is asynchronous — poll GET /v1/data-exports/{id} for status and (once status == "completed") freshly-signed download URLs for each part.

post/data-exports

Request

  • Base URL: https://api.cogram.com/v1
  • URL: https://api.cogram.com/v1/data-exports
  • Auth: HTTP bearer

Request body

project_idsstring[] nullable

Project KSUIDs to scope the data_export to. Omit for an org-wide data_export, which carries the 6-month cap. Duplicates are collapsed.

project_idstring nullable

Deprecated single-project form of project_ids.

document_formatsstring[]

Rendered document formats to emit per field report and observation, alongside the JSON. Empty (the default) ships metadata and raw blobs only. Does not affect meeting.docx, which every export includes. Rendering makes a build slower and its zip larger.

Response

Successful Response

idstring required
organization_idstring required
source'ui' | 'api' required
requester_user_idstring nullable required

ui source only.

requester_api_key_idstring nullable required

api source only.

requester_api_key_namestring nullable required

api source only. Prefer this over parsing requester_display.

requester_forwarded_userstring nullable required

X-Forwarded-User header value at create time.

requester_displaystring required

Human-readable attribution: the user's name (their email if the name is empty), API key '<name>', or <forwarded_user> (via API key '<name>'). Degrades to <forwarded_user> (via deleted API key) or unknown when the linked user or key row was deleted after the export was created.

project_idsstring[] required

Scope as requested — empty for org-wide exports. Retains ids of projects deleted after the export was created, so projects may be shorter.

project_idstring nullable required

Set only for single-project exports; null otherwise.

project_namestring nullable

Set only when project_id is set.

project_customer_idstring nullable

Customer's own project label. Not unique — use project_id for identity.

document_formatsstring[] required

Echo of the request. Typed loosely so a row written by a newer deployment, carrying a format this one does not know, still serializes instead of failing the whole listing.

status'pending' | 'running' | 'cancelling' | 'cancelled' | 'completed' | 'failed' | 'expired' required
errorstring nullable required

Set when status is failed.

requested_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Also set on failure and cancellation.

expires_atstring date-time nullable required

Parts are deleted at this time, 7 days after completion.

Changes

No recorded changes to this operation across all 2 revisions of this API.