logo

Retrieve a data export request

Retrieves a data export request.

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

ID of the resource.

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

Name of the export.

format
required
string

Output format of the export.

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

Type of resource to export.

id
string <= 50 characters

ID of the export.

object

Export request arguments used to filter and sort the result set. For more information, see Arguments.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
string

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

emailNotification
Array of strings <email>

List of email addresses to notify when an export is completed.

fields
Array of strings

List of fields to include in the export. For more information, see Arguments.

object

Recurring export schedule.

instruction
required
string

Schedule instruction in Recurrence Rule RFC 5545 format.

start
string <date-time>

Date and time when the first scheduled recurring export occurs. The default value is now.

userId
string

ID of the user who requested the data export.

recordCount
integer

Total number of records in the export, excluding the header row.

scheduledTime
string <date-time>

Date and time when the data export is scheduled to generate a file.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

status
string

Status of export request.

Enum: "pending" "queued" "processing" "completed"
Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "user" "download" "signedLink"
object

Date range of the data export. If this value is not set, all data is included. For more information, see Date ranges.

start
required
string

Start date of the data export. This field accepts any argument in datetime format.

end
required
string

End date of the data export. This field accepts any argument in datetime format.

field
string
Default: "createdTime"

Field to which the date range is applied.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/experimental/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": {
    }
}
➔ Next to Modify a data export