Use the Extract method to extract a package to a Marketing Cloud Engagement FTP site. Specify the File Transfer Location only when the intent is to deliver the file to a different FTP site. To reduce performance impacts, run data extracts outside of working hours.
Parameters
This method has the parameters described in this table.
| Name | Data Type | Description |
|---|---|---|
RequestID |
String | A unique identifier for the request. |
Requests |
Array of ExtractRequest objects | The requests specifying execution properties for a method. |
Results |
Array of ExtractResult[] objects | The results of a method execution returned as an output parameter. |
Usage
This sample SOAP envelope demonstrates how to use the Extract method to initiate a data extract.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">Extract</a:Action>
<a:MessageID>urn:uuid:137067bb-1ec4-43e7-ba83-a183bexample</a:MessageID>
<ActivityId CorrelationId="001eee78-681b-4165-9364-9610316736bb"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
e6c2db06-4440-4a6d-8e23-abc0c7ee0e64</ActivityId>
<a:ReplyTo>
<a:Address>
http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address>
</a:ReplyTo>
<a:To s:mustUnderstand="1">
https://YOUR_SUBDOMAIN.soap.marketingcloudapis.com/Service.asmx</a:To>
<fueloauth xmlns="http://exacttarget.com">YOUR_ACCESS_TOKEN</fueloauth>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExtractRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
<Requests>
<ID>c7219016-a7f0-4c72-8657-1ec12example</ID>
<Parameters>
<Parameter>
<Name>StartDate</Name>
<Value>4/1/2026 1:00:00 AM</Value>
</Parameter>
<Parameter>
<Name>EndDate</Name>
<Value>5/31/2026 1:00:00 AM</Value>
</Parameter>
<Parameter>
<Name>ExtractBounces</Name>
<Value>true</Value>
</Parameter>
<Parameter>
<Name>ExtractClicks</Name>
<Value>true</Value>
</Parameter>
<Parameter>
<Name>ExtractConvers</Name>
<Value>true</Value>
</Parameter>
</Parameters>
</Requests>
</ExtractRequestMsg>
</s:Body>
</s:Envelope>
The response provides the status and a unique ID for the request.
<soap:Body>
<ExtractResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
<OverallStatus>OK</OverallStatus>
<RequestID>03bc4f0a-5527-4b10-8743-f9456example</RequestID>
<Results />
</ExtractResponseMsg>
</soap:Body>