LAlatitude-dev
Datasets

Export dataset rows

Changed on

Exports the selected rows as CSV. Returns one of three outcomes, discriminated by status:

  • "ready" — the export fit in the synchronous path. Body carries a short-lived signed downloadUrl the caller follows with a plain HTTP GET.
  • "queued" — the export was too large for the synchronous path AND a recipient was supplied. The CSV will be emailed to that address. The recipient must be a member of the requesting organization.
  • "too_large" — the export was too large for the synchronous path AND no recipient was supplied. Body includes a recommendedAction describing how to recover (typically: ask the user for an email and retry with recipient set).
post/v1/projects/{projectSlug}/datasets/{datasetSlug}/rows/export

Request

  • Base URL
    https://api.latitude.so
  • Auth
    HTTP bearer

Path parameters

projectSlugstring required

Project slug (human-readable identifier)

Project slug (human-readable identifier). The CLI can also read this from the LATITUDE_PROJECT_SLUG environment variable.

datasetSlugstring required

Dataset slug (human-readable identifier within the project).

Request body

recipientstring email

Email address to send the download link to when the export is too large for the synchronous path. Must belong to a member of the requesting organization. Ignored when the export fits the synchronous path; required for the async email flow.

Response

CSV ready at the signed URL

status'ready' required

Always "ready". The CSV is available at downloadUrl.

downloadUrlstring required

Short-lived signed URL pointing to the CSV in object storage. Follow it with a plain HTTP GET.

filenamestring required

Suggested filename for the downloaded CSV.

expiresAtstring required

ISO-8601 timestamp at which downloadUrl stops working.

rowCountinteger required

Number of rows included in the export.

Changes

  • b1124fb6b4f2Revision changes
    • info

      added the non-success response with the status

  • 4e09c5b2704fRevision changes
    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the success response with the status