CreateExportJob
Create an export job for the search criteria defined via the filter aggregate input. Returns the 'JobId' which can be passed as a parameter in subsequent calls to Bulk Export Activities. Use EnqueueExportJob to queue the export job for processing. Use GetExportJobStatus to retrieve status of export job.
Execute
Sample EXECUTE CreateExportJob Table='Leads', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'
EXECUTE CreateExportJob Table='Leads', Columns='Id,test98,updatedAt,*', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'
Input
Name | Type | Required | Description |
Table | String | True | The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
Format | String | False | Format of export file to be generated.
The allowed values are CSV, TSV, SSV. The default value is CSV. |
Columns | String | False | Comma separated list of columns that you want to retrieve. Defaults to * (all columns). You can specify different header names for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. The exported file headers will be built using API names. Exported file column names can be changed using the Columns input. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
FiltersAggregate | String | False | JSON aggregate for the filters required in the request body. |
Result Set Columns
Name | Type | Description |
Id | String | The Id of the export job. |
Format | String | The format of the export job. |
CreatedAt | Datetime | The date when the export job was created. |
Status | String | The status of the export process. |
Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
Details | String | Details of execution failure. NULL if success=true. |