Exporting Data

Last updated on June 26, 2024.

You can export data using either the CLI or the raw export API. This method can be helpful when test data is needed for a service, e.g. in a staging environment.

Data export with the CLI

The Insites CLI tool features the command. Its options are listed below:

  • : A file path to a JSON file that will be created by the CLI and where the exported data is stored.
  • : By default, export will use the autogenerated for the field. When this option is set, it will use the normal from the object.

Under the hood, the CLI uses the export API described in the next section. However, using the CLI provides some significant benefits:

  • Leveraging the CLI's authentication mechanism (i.e. you don't need to send your authentication token manually).
  • Writing downloaded data directly to the file system.

Example:

Data export using CSV files

You can import and export files in CSV format. To use this feature,  requires an additional parameter:

Data export with raw export API

Our CLI uses the HTTP API to schedule an export task. Once it is finished, you can download the data.

Data export with GraphQL

It is possible to export data with GraphQL queries.

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.