Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • CSV
  • Excel
  • RAW (ConfiForms internal format, useful for use with Migration and Recovery API to restore/recover form's data if/when needed with complete copy)

The endpoint to use is https://app.confiforms.net/export/api/v1

...

URLMethodDetails

/download/{pageId}/{formName}

(in this case set Auth-Token header)


/download/{pageId}/{formName}/{token}

GET

Request parameters (both optional):

  • format - Supported values:
    • excel
    • csv - default format
    • raw
    • json
  • query - ConfiForms Filters type of expression, url encoded. If left empty then all records are returned
  • fields -  used to decorate and transform the returned values with Virtual functions. Use "," to separate field decoration instructions.

Example:

Code Block
https://app.confiforms.net/export/api/v1/download/123456/myform/xxx-xxx-xxx-xxx?format=csv&query=sum%3A%3E350%20AND%20type%3AInvoice

(sum%3A%3E350%20AND%20type%3AInvoice is an encoded value of sum:>350 AND type:Invoice)