Retrieve a data export request

Retrieve a data export request.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

query Parameters
expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

Data Export request.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
name
required
string

Export name.

format
required
string

Export result format.

Enum: "csv" "json" "json-api" "xml" "pdf"
resource
required
string

The type of resource being exported (e.g. transactions).

id
string <= 50 characters

The export identifier string.

object

Export request arguments that can be passed to filter and/or sort the result set. See the arguments guide for more options and examples.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields.

sort
string

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

emailNotification
Array of strings <email>

List of emails to be notified when export is completed.

fields
Array of strings

List of fields to include in the export. See supporting documentation for more info. If omitted, default fields will be included.

object

Exports can reoccur according to your own schedule.

instruction
required
string

RRule RFC 5545 formatted string used for recurring exports.

start
string <date-time>

The date and time when the first recurring scheduled export will occur. Defaults to now.

userId
string

The ID of the User who requested the data export.

recordCount
integer

The number of records in the export (excluding the header row).

scheduledTime
string <date-time>

The date and time this data export is scheduled to generate a file.

createdTime
string <date-time>

The time the data export was requested.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp. This value updates when the resource is updated.

status
string

Status of export request.

Enum: "pending" "queued" "processing" "completed"
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items

Related resource links.

Array ([ 1 .. 4 ] items)
Any of:
rel
required
string

Type of link.

Value: "self"
href
required
string

Link URL.

object

The date range (can be in relative formats). If omitted, all time will be included. See the Date Range guide for more options and examples.

start
required
string

Any valid datetime arguments including relative datetime arguments.

end
required
string

Any valid datetime arguments including relative datetime arguments.

field
string
Default: "createdTime"

The field to apply date range to.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/data-exports/{id}
Request samples
const queuedExport = await api.exports.get({resource: 'transaction', id: 'foobar-001'});
console.log(queuedExport.fields.status);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "resource": "customers",
  • "format": "csv",
  • "arguments": {
    },
  • "emailNotification": [
    ],
  • "fields": [
    ],
  • "recurring": {
    },
  • "userId": "string",
  • "recordCount": 0,
  • "scheduledTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "_links": [
    ],
  • "dateRange": {
    }
}