Submit a Ticket My Tickets
Welcome
Login  Sign up

REPORTS LoginExport API Version 1

REPORTS LoginExport API Version 1

Updated on 2014-04-01
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP


Summary:

Returns an array of logins, potentially filtered by role.


Resource/WSDL Page:

http://yourdomainhere/api/1/reports.asmx?op=LoginExport


Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

start_date
Required
Type: DATE
Length (max/Min): NA

Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY"

Example Values: 2014-04-24, 24-04-2014

role_id
Required
Type: BYTE
Length (Max/Min): 0-255

Must pass at least 0 as value.  Max value is 255. Use GET Roles API 

Example Values: 123

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 



Example Request

GET

http://demo.cakemarketing.com/api/1/reports.asmx/LoginExport?api_key=dNJFmId9rI&start_date=01/01/2012+12:00:00&end_date=08/10/2012+17:00:00&
role_id=0



Sample XML Response:

 

<ArrayOfLogin>
  <Login>
    <contact_id>41</contact_id>
    <contact_email_address>dan@cakemarketing.com</contact_email_address>
    <contact_first_name>John</contact_first_name>
    <contact_last_name>Doe</contact_last_name>
    <role_id>6</role_id>
    <role_name>Affiliate</role_name>
    <company_id>1864</company_id>
    <company_name>I Network</company_name>
    <ip_address>67.52.114.154</ip_address>
    <login_date>2012-08-09T12:18:39.933</login_date>
  </Login>
</ArrayOfLogin>



Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.