Skip to main content

Report Contact by Update DateTime

Updated

The Report Contact by Update DateTime command allows you to return a list of contacts subscribed to a list and updated in a specific date range.   

Arguments

The Report Contact by Update DateTime command requires the following arguments: Command, Realm, Password, List ID, From Date, and To Date.

api_web?r=myrealm&p=mypass&c=rpt_sub_by_update_datetime&list_id=5&start_datetime=01/01/2014&end_datetime=02/31/2014

The command is ‘rpt_sub_by_update_datetime’, the realm is ‘myrealm’ and the password is ‘mypass’.  The command will return the details for each contact updated in the range for the list with id='5'

The Report Contact by Update DateTime command supports the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=rpt_sub_by_update_datetime

c=rpt_sub_by_update_datetime

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

List ID

Yes

Identifier of the list to apply the command.

list_id=[list_id]
Start Date Yes Date to start reporting statistics, with or without time.

start_datetime=[mm/dd/yyyy%20hh:mm:ss]

start_datetime=[mm/dd/yyyy]
End Date Yes Date to end reporting statistics, with or without time.

end_datetime=[mm/dd/yyyy%20hh:mm:ss]

end_datetime=[mm/dd/yyyy]

Output Format

 

To specify the format of the list output, use one of two arguments.  If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.

csv=1 or

output_format=[csv,csv_tab, csv_pipe,xml]

Header

 

 To define the data with a label, use the Header argument.  This can only be used in conjunction with the output format, and does not affect XML.

headers=[0,1]

DEFAULT==0

 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?c=rpt_sub_by_update_datetime&r=myrealm&p=mypass&list_id=5&start_datetime=06/01/2013&end_datetime=06/20/2013&output_format=csv&headers=1

Successful results return:

"subscriber_id","email","first_name","last_name","company","address_1","address_2","city","state","zip","contry","phone","fax","created_date","update_date"
"123","jane@mydomain.com","Jane","Doe","","123 Sesame Street West","Suite 500","Seattle","WA","98104","US","206.555.1212","206.555.1213","2013-06-10 14:05:17","2013-06-18 09:22:11"
"124","john@mydomain.com","John","Doe","","123 Sesame Street West","Suite 500","Seattle","WA","98104","US","206.555.1212","206.555.1213","2013-06-16 14:05:17","2013-06-18 09:23:44"

Results

The Report Contact by Update DateTime command outputs either the results of the search or a FAILURE message. 

SUCCESS

The Report Contact by Update DateTime command does not explicitly return a Success code.  Instead, it outputs the contact data in plain text format.  Use the output_format argument to return the results in an alternate format.

FAILURE

A Report Contact by Update DateTime command will fail for several reasons, such as if the list doesn't exist.  The result format is:

FAILURE: [Reason]  

Related articles