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 RequestIDString A unique identifier for the request. RequestsArray of ExtractRequest objects The requests specifying execution properties for a method. ResultsArray 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.
1 < s:Envelope xmlns:s = "http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:a = "http://schemas.xmlsoap.org/ws/2004/08/addressing" >
3 < s:Header >
4 < a:Action s:mustUnderstand = "1" > Extract </ a:Action >
5 < a:MessageID > urn:uuid:137067bb-1ec4-43e7-ba83-a183bexample </ a:MessageID >
6 < ActivityId CorrelationId = "001eee78-681b-4165-9364-9610316736bb"
7 xmlns = "http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics" >
8 e6c2db06-4440-4a6d-8e23-abc0c7ee0e64 </ ActivityId >
9 < a:ReplyTo >
10 < a:Address >
11 http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous </ a:Address >
12 </ a:ReplyTo >
13 < a:To s:mustUnderstand = "1" >
14 https://YOUR_SUBDOMAIN.soap.marketingcloudapis.com/Service.asmx </ a:To >
15 < fueloauth xmlns = "http://exacttarget.com" > YOUR_ACCESS_TOKEN </ fueloauth >
16 </ s:Header >
17 < s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
18 xmlns:xsd = "http://www.w3.org/2001/XMLSchema" >
19 < ExtractRequestMsg xmlns = "http://exacttarget.com/wsdl/partnerAPI" >
20 < Requests >
21 < ID > c7219016-a7f0-4c72-8657-1ec12example </ ID >
22 < Parameters >
23 < Parameter >
24 < Name > StartDate </ Name >
25 < Value > 4/1/2026 1:00:00 AM </ Value >
26 </ Parameter >
27 < Parameter >
28 < Name > EndDate </ Name >
29 < Value > 5/31/2026 1:00:00 AM </ Value >
30 </ Parameter >
31 < Parameter >
32 < Name > ExtractBounces </ Name >
33 < Value > true </ Value >
34 </ Parameter >
35 < Parameter >
36 < Name > ExtractClicks </ Name >
37 < Value > true </ Value >
38 </ Parameter >
39 < Parameter >
40 < Name > ExtractConvers </ Name >
41 < Value > true </ Value >
42 </ Parameter >
43 </ Parameters >
44 </ Requests >
45 </ ExtractRequestMsg >
46 </ s:Body >
47 </ s:Envelope >
The response provides the status and a unique ID for the request.
1 < soap:Body >
2 < ExtractResponseMsg xmlns = "http://exacttarget.com/wsdl/partnerAPI" >
3 < OverallStatus > OK </ OverallStatus >
4 < RequestID > 03bc4f0a-5527-4b10-8743-f9456example </ RequestID >
5 < Results />
6 </ ExtractResponseMsg >
7 </ soap:Body >