Exporting data for integrations

Several types of data can be exported from Movement via the API.

The API design pattern for these requests are:

1. A request is made to begin an export, via the relevant API method. In this request, a webhook URL is specified which will receive the results
2. This request returns a password, via a JSON payload
3. The export is completed asynchronously, then a link is sent to the webhook URL, or you poll an endpoint, waiting for the link to be ready. The password returned is used to decrypt the file

An example integration could take several forms:

1. A miniature middleware API service, built in Flask (Python), Rails (Ruby), or any other web framework. This would periodically make a request to export data, and then would expose 1 API route which can receive a webhook from Movement. This could then push the resultant data into any 3rd party platform
2. A serverless function built on top of a service such as AWS Lambda, which receives a webhook, and pushes the resultant data into any 3rd party platform
3. A script in a Business Intelligence platform such as Microsoft PowerBI or IBM Cognos, which periodically requests an export, polls for the export CSV, and once it is ready, inserts it into the BI system.

Exports from the following methods are guaranteed once a request is accepted and a password is returned. If any parameters are incorrect when making a request for an export, these will return HTTP error codes outlined on the relevant route.

Exporting searches

Searches can be set up on any number of filters, and then exported via the API. This allows unlimited flexibility in setting up complex workflows, such as:

• exporting lists of members who have responded in a certain way to various campaigns
• exporting lists of members who have certain custom fields set
• exporting lists of members who have target demographics

Data from any search can be exported via the following API method:

• Searches: Export Targets

Exporting results from campaigns

Data from any campaign can be exported via the following API method:

• Campaigns: Export Campaign