BulkExportLeads
A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
Execute
Sample EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z'
EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='/tmp/export.csv'
EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-02-25T00:00:00Z', Columns='Id'
EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-01-10T00:00:00Z', Columns='id=LeadID,*'
EXECUTE BulkExportLeads SmartListName='CDataSmartList'
EXECUTE BulkExportLeads StaticListName='ImportTest0407_csv'
EXECUTE BulkExportLeads SmartListId=12
EXECUTE BulkExportLeads StaticListId=13
Input
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified 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. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| CreatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead creation datetime. |
| CreatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead creation datetime. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| StaticListId | Integer | False | The id of a static list you want to use as a filter. |
| StaticListName | String | False | The name of a static list you want to use as a filter. |
| SmartListId | Integer | False | The id of a smart list you want to use as a filter. |
| SmartListName | String | False | The name of a smart list you want to use as a filter. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
Result Set Columns
| Name | Type | Description |
| Id | String | The Id of the export job. |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| 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. |