Skip to content
API docs
Sign inOpen app

Exports

Cancel an export

POST/v1/exports/{exportId}/cancel

Stop an export that is still being prepared, and delete what it wrote so far. An export that already finished stays as it is. Returns the export.

Path parameters

  • exportIdstringrequired

    The export's id.

Response

  • idstringrequired

    The export's id.

  • formIdstringrequired

    The form whose responses it exports.

  • statusenumrequired

    running while the file is being prepared, with rows counting the responses written so far. ready once you can call POST /v1/exports/{exportId}/download, and the file is kept for a day. expired once the file was deleted, so export again. failed when it went wrong, and error says why. canceled when someone stopped it.

    One of "running", "ready", "failed", "canceled", "expired"

  • rowsnumberrequired

    How many responses were written so far. Once ready, it's all of them.

  • bytesnumberrequired

    The file's size so far, in bytes.

  • filenamestringrequired

    The CSV file's name.

  • filteredbooleanrequired

    Whether any filter was on. A filtered file has "-filtered-" in its name.

  • filtersobjectrequired

    The filters and sort it was asked for, as in GET /v1/submissions.

    Show 9 fields
    • statusenum

      One of "partial", "complete"

    • stateenum

      One of "started", "left", "finished"

    • endingIdstring
    • consentenum

      One of "agreed", "not_agreed", "not_asked"

    • fromnumber
    • tonumber
    • searchstring
    • sortenum

      One of "createdAt", "status", "ending", "contact"

    • orderenum

      One of "desc", "asc"

  • errorstring or nullrequired

    Why it failed. Null otherwise.

  • minebooleanrequired

    Whether you started it. Over the API, that means with this key.

  • createdAtnumberrequired

    When it started, in milliseconds since the epoch.

  • finishedAtnumber or nullrequired

    When it stopped running, in milliseconds since the epoch. Null while it runs.

Errors answer with a status and the error shape.