Overview

Installation

pipinstallFuelSDKWrapper

Getting Started

Configuring

params= {"clientid":"YOUR_CLIENT_ID","clientsecret":"YOUR_CLIENT_SECRET"}api=ET_API(params=params)

Examples

Get the List objects

# Add a require statement to reference the FuelSDK functionalityfromFuelSDKWrapperimportET_API,ObjectType# Next, create an instance of the ET_API classapi=ET_API()# Get the List objectsresponse=api.get_objects(ObjectType.LIST)# Print out the results for viewingprint('Post Status: {}'.format(response.status))print('Code: {}'.format(response.code))print('Message: {}'.format(response.message))print('Result Count: {}'.format(len(response.results)))print('Results: {}'.format(response.results))

Some examples of utilization

fromFuelSDKWrapperimportET_API,ObjectType,Operator,FolderType,simple_filter,complex_filterfromdatetimeimportdatetime,timedeltaapi=ET_API()# Get Subscriber Data using the IN Operatorresponse=api.get_objects(ObjectType.SUBSCRIBER,simple_filter("EmailAddress",Operator.IN, ["my.email@domain.com","your.email@domain.com"]))# Find Query Definition using the LIKE Operatorresponse=api.get_objects(ObjectType.QUERY_DEFINITION,simple_filter("QueryText",Operator.LIKE,"FROM My_DE"),property_list=["Name","CategoryID","QueryText"])# Get Jobs sent in the last 30 daysstart_date=datetime.now()-timedelta(days=30)response=api.get_objects(ObjectType.SEND,simple_filter("SendDate",Operator.GREATER_THAN,start_date))# Get Folder Dataresponse=api.get_objects(ObjectType.FOLDER,complex_filter(simple_filter("Name",Operator.EQUALS,"My_Folder_Name"),"OR",simple_filter("Name",Operator.EQUALS,"My_Other_Folder_Name")    ),property_list=["ID","Name"])# Get Folder Full Pathfolder_id=12345response=api.get_folder_full_path(folder_id)# Get or Create Folder Full Pathfolder_names= ["Test","Sub_Test"]folder_type=FolderType.DATA_EXTENSIONSresponse=api.get_or_create_folder_hierarchy(folder_type,folder_names)# Start an Automationresponse=api.start_automation("Automation_Key")# Seng Trigger Emailresponse=api.send_trigger_email("MyTriggerKey","email@email.com","subscriberkey@email.com",attributes={"first_nm":"Sebastien","birth_dt":"1/1/1990"})# Get Tokensshort_token=api.get_client().authTokenlong_token=api.get_client().internalAuthToken# Get Data Extension Fields sorted by Ordinalfields=sorted(api.get_data_extension_columns("My_DE_Key").results,key=lambdax:x.Ordinal)# Clear Data Extensionresponse=api.clear_data_extension("DE_Key")# Create Batch of Data Extension Rows# Synchronouskeys_list= [    ["Field1","Field2","Field3"],# Fields for Row 1    ["Field1","Field2","Field3"],# Fields for Row 2    ["Field1","Field2","Field3"]# Fields for Row 3]values_list= [    ["Row1_Value1","Row1_Value2","Row1_Value3"],    ["Row2_Value1","Row2_Value2","Row2_Value3"],    ["Row3_Value1","Row3_Value2","Row3_Value3"]]rows_inserted_count=api.create_data_extension_rows("DE_Key",keys_list,values_list)# Asynchronous Insert and Upsertitems_list= [    {"Field1":"Value1","Field2":"Value2","Field3":"Value3"},# Row 1    {"Field1":"Value1","Field2":"Value2","Field3":"Value3"},# Row 2    {"Field1":"Value1","Field2":"Value2","Field3":"Value3"}# Row 3]res=api.create_data_extension_rows_async("DE_Key",items_list)res=api.upsert_data_extension_rows_async("DE_Key",items_list)# Retrieve Data Extension Rows via REST API for more advanced parametersitems,items_count=api.get_data_extension_rows_rest(customer_key="DE_CUSTOMER_KEY",search_filter=complex_filter(simple_filter("first_name",Operator.EQUALS,"John"),'AND',simple_filter("last_name",Operator.EQUALS,"Doe")    ),property_list=["email_address","first_name","last_name"],order_by="first_name ASC,last_name DESC",page_size=100,page=5)items,items_count=api.get_data_extension_rows_rest(customer_key="DE_CUSTOMER_KEY",search_filter=simple_filter("full_name",Operator.LIKE,"Jo%Doe"),property_list=["email_address","full_name"],max_rows=300)items,items_count=api.get_data_extension_rows_rest(customer_key="DE_CUSTOMER_KEY",search_filter=simple_filter("first_name",Operator.IN, ["Jane","John"]),top=100)# Get Email Rendered Previewres=api.get_objects(ObjectType.EMAIL,simple_filter("Name",Operator.EQUALS,"BCLA_202001_06-LIVE"),property_list=["ID"])email_id=res.results[0].IDres=api.get_email_preview(email_id,data_extension_key="My_DE_Key",contact_key="My_Contact_Key")# Retrieve All Subscribers List ID# The real ID is not what is sent by the SOAP List objectall_subscribers_list_id=api.get_all_subscribers_list_id()

Get More Results

response=api.get_objects(ObjectType.LIST_SUBSCRIBER,simple_filter("ListID",Operator.EQUALS,1234),property_list=["ID"])total=len(response.results)whileresponse.more_results:response=api.get_more_results()total+=len(response.results)

Extract Request

start_date=datetime.now()-timedelta(days=30)end_date=datetime.now()response=api.extract_data(parameters={"AccountIDs":"123456","_AsyncID":0,"StartDate":start_date,"EndDate":end_date,"ExtractSent":"true","ExtractSendJobs":"true","ExtractBounces":"false","ExtractClicks":"false","ExtractOpens":"false","ExtractUnsubs":"false","ExtractConversions":"false","IncludeTestSends":"false","IncludeUniqueClicks":"false","IncludeUniqueOpens":"false","ExtractSurveyResponses":"false","Format":"tab","OutputFileName":"extract.zip"})

Perform Request

response=api.get_objects(ObjectType.IMPORT_DEFINITION,simple_filter("Name",Operator.EQUALS,"Import_my_file"))try:import_def=response.results[0]response=api.perform_action("start",import_def)exceptIndexError:print("No Import Definition found")

List SOAP API Object Properties

response=api.get_info(ObjectType.CONTENT_AREA)

Responses

Debug

api=ET_API(debug=True)

Requirements