Create an activity export definition
post
/api/bulk/2.0/activities/exports
Creates a new activity export definition. After a successful request, the next step is to synchronize the data. See the tutorial for details on how to export data.
Request
Supported Media Types
- application/json
- text/csv
Root Schema : ActivityExportIndividual
Type:
objectTitle:
Show Source
ActivityExportIndividual-
areSystemTimestampsInUTC:
boolean
Title:
areSystemTimestampsInUTC -
autoDeleteDuration:
string
Title:
autoDeleteDuration -
createdAt:
string(date-time)
Title:
createdAt -
createdBy:
string
Title:
createdBy -
crmAccountIdField:
string
Title:
crmAccountIdField -
dataRetentionDuration:
string
Title:
dataRetentionDuration -
externalSystemId:
integer
Title:
externalSystemId -
fields:
object fields
Title:
fields -
filter:
string
Title:
filter -
kbUsed:
integer(int64)
Title:
kbUsed -
maxRecords:
integer
Title:
maxRecords -
name:
string
Title:
name -
productIdField:
string
Title:
productIdField -
updatedAt:
string(date-time)
Title:
updatedAt -
updatedBy:
string
Title:
updatedBy -
uri:
string
Title:
uri
Nested Schema : fields
Type:
objectTitle:
fieldsResponse
Supported Media Types
- application/json
201 Response
Success.
Root Schema : ActivityExportIndividualResponse
Type:
objectTitle:
Show Source
ActivityExportIndividualResponse-
areSystemTimestampsInUTC:
boolean
Title:
areSystemTimestampsInUTC -
autoDeleteDuration:
string
Title:
autoDeleteDuration -
createdAt:
string(date-time)
Title:
createdAt -
createdBy:
string
Title:
createdBy -
crmAccountIdField:
string
Title:
crmAccountIdField -
dataRetentionDuration:
string
Title:
dataRetentionDuration -
externalSystemId:
integer
Title:
externalSystemId -
fields:
object fields
Title:
fields -
filter:
string
Title:
filter -
kbUsed:
integer(int64)
Title:
kbUsed -
maxRecords:
integer
Title:
maxRecords -
name:
string
Title:
name -
productIdField:
string
Title:
productIdField -
updatedAt:
string(date-time)
Title:
updatedAt -
updatedBy:
string
Title:
updatedBy -
uri:
string
Title:
uri
Nested Schema : fields
Type:
objectTitle:
fields400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to create a new activity export definition using an HTTP request and cURL. For more information on requests, see API requests. See the tutorial for details on how to export data.
HTTP Request Example
Create a new activity export definition:
POST /activities/exports
Content-Type: application/json
Request body:
{
"name":"Form submit activity id export",
"fields":{
"ActivityId":"{{Activity.Id}}"
},
"filter":"'{{Activity.Type}}'='FormSubmit'"
}
Response:
{
"name":"Form submit activity id export",
"fields":{
"ActivityId":"{{Activity.Type}}"
},
"filter":"'{{Activity.Type}}'='FormSubmit'",
"dataRetentionDuration":"PT12H",
"id":"/activities/exports/29386",
"createdBy":"API.User",
"createdAt":"2015-08-17T19:08:29.2772694Z",
"updatedBy":"API.User",
"updatedAt":"2015-08-17T19:08:29.2772694Z"
}
cURL Example
Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.
curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"name":"Form submit activity id export","fields":{"ActivityId":"{{Activity.Id}}"},"filter":"'{{Activity.Type}}'='FormSubmit'"}' https://secure.p03.eloqua.com/api/bulk/2.0/activities/exports