GET /reports/leads/date/{date}

Updated on
 
Return a list of leadItems for a given date.  See leadItem element definition in WSDL/XSD
This resource requires connectid, nonce, date and signature for authentication. See Authentication documentation for REST and SOAP. Passing authentication information as query parameters for REST is supported.

Notes

  • If you would like to see which leads had their status changed on a certain date - i.e. were approved, confirmed or rejected - set datetype=modified_date.

Resource URL

XML:  https://api.zanox.com/xml/2011-03-01/reports/leads/date/{date}
JSON:  https://api.zanox.com/json/2011-03-01/reports/leads/date/{date}

Parameters

date
required

URL path parameter. Request leads for this date.

Value Type: Date in format YYYY-MM-DD
Example Value: 2013-01-31

datetype
optional

Request leads according to when they were tracked ("tracking_date"), when they were last modified in any way ("modified_date") or when the review state was changed ("review_state_changed_date"). Default is tracking_date.

Note that the above values only apply to REST requests. For SOAP requests, the possible values are clickDatetrackingDate, modifiedDate, and 
reviewStateChangedDate.

Value Type: String
Example Values 

program
optional

Limits results to those that are associated with a particular program.

Value Type: String
Example Values 

adspace
optional

Limits results to those that are associated with a particular Adspace.

Value Type: String
Example Values:  

items
optional

number of items in the result set [1..n]

Value Type: integer
Example Values 1 (default = 10; maximum = 50) 

page
optional

page position [0..n] 

Value Type: integer
Example Values 1 (default: 0)

state
optional

Limits results to leads having one of the following review states:

Value Type: String
Example Values "confirmed", "open", "approved", "rejected"

Example Request

REST authentication information must be included in request headers or added as query parameters

Get details of all leads on August 5th, 2012:

http://api.zanox.com/xml/2011-03-01/reports/leads/date/2014-02-01

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<GetLeadsResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>2</items>
    <total>2</total>
    <leadItems>
        <leadItem id="10293919-129c-dcc1-c67a-1523adsc2123">
            <reviewState>confirmed</reviewState>
            <trackingDate>2014-02-01T04:15:35.703+01:00</trackingDate>
            <modifiedDate>2014-05-02T04:30:29.480+02:00</modifiedDate>
            <clickDate>2014-01-30T04:34:50.707+01:00</clickDate>
            <adspace id="102938">Adspace one</adspace>
            <admedium id="102948">Sidebar 120x600</admedium>
            <program id="33354">Test Program</program>
            <clickId>4920304020939182822</clickId>
            <clickInId>0</clickInId>
            <commission>0.4</commission>
            <currency>EUR</currency>
            <gpps>
                <gpp id="zpar0">test19293019x19238ad3716d51adcd1626371ada2716311</gpp>
            </gpps>
        </leadItem>
        <leadItem id="1523415a-abbc-22ac-1234-15234abcd123">
            <reviewState>confirmed</reviewState>
            <trackingDate>2014-02-01T08:56:34.897+01:00</trackingDate>
            <modifiedDate>2014-04-11T19:05:51.993+02:00</modifiedDate>
            <clickDate>2014-02-01T08:46:54.777+01:00</clickDate>
            <adspace id="102939">Adspace two</adspace>
            <admedium id="493857">120x60 Logo Main</admedium>
            <program id="33123">TEST Prog DE</program>
            <clickId>1283918483783492844</clickId>
            <clickInId>0</clickInId>
            <commission>9.0</commission>
            <currency>EUR</currency>
            <gpps>
                <gpp id="zpar0">1727371aXXAAtest81273619199hdjauwhduaowidjksjhagaj</gpp>
            </gpps>
        </leadItem>
    </leadItems>
</GetLeadsResponse>

 

Resource Information

Rate Limited? No
Authentication Requires signature. See
REST Authentication
SOAP Authentication
Response Formats json, xml
HTTP Methods GET
Resource family reports
Response Object reportItem
API Version 2011-03-01