Request a data export of selected resource.
expand | string Expand a response to get a full related object included inside of the |
Data Export Request.
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
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. | |||||||
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. | |||||||
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. | |||||||
|
Data export request received.
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||
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. | |||||||
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. | |||||||
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> Read-only timestamp, automatically assigned on back-end. | ||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
status | string Status of export request. | ||||||
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items The links related to resource. | |||||||
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. | |||||||
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "name": "string",
- "resource": "customers",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "dateRange": {
- "start": "yesterday",
- "end": "today",
- "field": "createdTime"
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "resource": "customers",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "dateRange": {
- "start": "yesterday",
- "end": "today",
- "field": "createdTime"
}
}
Retrieve a list of data export requests.
limit | integer [ 0 .. 1000 ] The collection items limit. |
offset | integer >= 0 The collection items offset. |
sort | Array of strings The collection items sort field and order (prefix with "-" for descending sort). |
expand | string Expand a response to get a full related object included inside of the |
filter | string The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format. |
q | string The partial search of the text fields. |
criteria | string Criteria parameter for requesting a collection. |
A list of data export requests was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||
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. | |||||||
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. | |||||||
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> Read-only timestamp, automatically assigned on back-end. | ||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
status | string Status of export request. | ||||||
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items The links related to resource. | |||||||
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. | |||||||
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
// all parameters are optional const firstCollection = await api.exports.getAll(); // alternatively you can specify one or more of them const params = {limit: 20, offset: 100, sort: '-createdTime'}; const secondCollection = await api.exports.getAll(params); // access the collection items, each item is a Member secondCollection.items.forEach(file => console.log(exports.fields.status));
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "resource": "transactions",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
]
Retrieve a data export request.
expand | string Expand a response to get a full related object included inside of the |
Data Export request.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||
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. | |||||||
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. | |||||||
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> Read-only timestamp, automatically assigned on back-end. | ||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
status | string Status of export request. | ||||||
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items The links related to resource. | |||||||
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. | |||||||
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const queuedExport = await api.exports.get({resource: 'transaction', id: 'foobar-001'}); console.log(queuedExport.fields.status);
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "resource": "customers",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "dateRange": {
- "start": "yesterday",
- "end": "today",
- "field": "createdTime"
}
}
A data export may be changed as long as it is still pending.
expand | string Expand a response to get a full related object included inside of the |
Data Export Request.
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
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. | |||||||
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. | |||||||
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. | |||||||
|
Data Export was modified.
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||
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. | |||||||
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. | |||||||
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> Read-only timestamp, automatically assigned on back-end. | ||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
status | string Status of export request. | ||||||
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items The links related to resource. | |||||||
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. | |||||||
|
Data Export was updated.
name required | string Export name. | ||||||
format required | string Export result format. | ||||||
resource required | string The type of resource being exported (e.g. transactions). | ||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||
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. | |||||||
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. | |||||||
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> Read-only timestamp, automatically assigned on back-end. | ||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||
status | string Status of export request. | ||||||
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items The links related to resource. | |||||||
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. | |||||||
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "name": "string",
- "resource": "customers",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "dateRange": {
- "start": "yesterday",
- "end": "today",
- "field": "createdTime"
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "resource": "customers",
- "format": "csv",
- "arguments": {
- "filter": "string",
- "sort": "string",
- "q": "string"
}, - "emailNotification": [
- "user@example.com"
], - "fields": [
- "string"
], - "recurring": {
- "instruction": "string",
- "start": "2019-08-24T14:15:22Z"
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "dateRange": {
- "start": "yesterday",
- "end": "today",
- "field": "createdTime"
}
}
Delete an existing data export.
Request was accepted, but no response body is returned.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/experimental/organizations/unknown/data-exports/{id}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}