HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

Create an Export

post
https://app.referralsaasquatch.com/api/v1//export

Creates an asynchronous request for an Exports. Depending on the size of the Export and other exports in the export pipeline, it may take awhile for an export request to complete. Once the Export is completed, it can be downloaded in the requested format (CSV or zipped XLSX) using the download URL endpoint.

Here are a few ways to check for when an export is ready:

  • Polling — While an export is being prepared you can check the status using the id. Make sure you store the id of the export when you request it.
  • Webhooks — When an export is complete, a webhook event will be fired. Make sure you create a webhook endpoint subscription before you create your export.
  • Listing — You can use the API to list recent exports, and check their status.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Body Params

Details of the export to be created

An Export lets you get your customer data out of your Advocate tenant. There are exports for returning Users, Referrals and Reward Balances.

string
enum
required

The type of Export that's being requested.

Allowed:
string
enum
Defaults to CSV

The format of the Export

Allowed:
string

A user-friendly name for this report. Useful for keeping track of which report is which.

string

Detail on the service or user that requested this report.

params
object

Filter parameters for limiting the types of results returned. When parameters are included, their are grouped by a logical "AND" so it's possible to create situations that return no results.

Responses

Updated 2 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago