GET /reports/basic

Updated on
 
Request a report for a given date range. This report contains a basic statistic of views, clicks, leads and sales. Furthermore it contains the status of leads and sales.  See ReportBasic 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.

Resource URL

XML:   https://api.zanox.com/xml/2011-03-01/reports/basic/
JSON: https://api.zanox.com/json/2011-03-01/reports/basic/

Parameters

fromdate
mandatory

start date of the timeperiod to get a report. startdate is inclusive. ie. transactions of this date will be in the result

Value Type: string
Example Values fromdate=2013-10-18 

todate
mandatory

to date of the timeperiod to get a report. enddate is exclusive. ie. transactions of this date will not be displayed in the result (e.g. until YYYY-MM-DD 00:00:00)

Value Type: string
Example Values todate=2013-10-20 

datetype
optional

datetype specifies the date parameter above. Currently only the TRACKING_DATE is supported. 

Value Type: DateTypeEnum (toString)
Example Values todate=2013-10-20 

currency
optional

filter your reports for specified currencies 

The API does not do any currency conversion; only results from the selected currency will be displayed

Value Type: string
Example Values currency=EUR 

program
optional

filter your reports for specified programs 

Value Type: integer
Example Values program=123 

admedium
optional

filter your reports for specified admedia 

Value Type: integer
Example Values admedia=123 

adspace
optional

filter your reports for specified adspace 

Value Type: integer
Example Values adspace=123 

state
optional

filter your reports for specified state 

Value Type: ReviewStateEnum (toString)
Example Values state=123 

groupby
optional

a list of grouping parameters defines for which parameters the reports should be grouped.(CURRENCY, ADMEDIUM, PROGRAM, ADSPACE, LINK_FORMAT, MEDIA_SLOT, MONTH, DAY, YEAR)

Value Type: String (case-insensitive)
Example Values groupBy=day

Example Request

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

Get basic details from 18.10.2013 to 20.10.2013 

https://api.zanox.com/xml/2011-03-01/reports/basic?fromdate=2013-10-18&todate=2013-10-20

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<GetReportBasicResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>1</items>
    <total>1</total>
    <reportItems>
        <reportItem>
            <currency>EUR</currency>
            <day>2013-10-18</day>
            <total>
                <viewCount>0</viewCount>
                <tpvCount>0</tpvCount>
                <clickCount>9873</clickCount>
                <clickCommission>868.32</clickCommission>
                <leadCount>0</leadCount>
                <leadCommission>0.0</leadCommission>
                <saleCount>10</saleCount>
                <saleCommission>159.5</saleCommission>
                <saleAmount>3560.8</saleAmount>
            </total>
            <open>
                <leadCount>0</leadCount>
                <leadCommission>0.0</leadCommission>
                <saleCount>10</saleCount>
                <saleCommission>169.5</saleCommission>
                <saleAmount>3570.8</saleAmount>
            </open>
            <approved>
                <leadCount>0</leadCount>
                <leadCommission>0.0</leadCommission>
                <saleCount>0</saleCount>
                <saleCommission>0.0</saleCommission>
                <saleAmount>0.0</saleAmount>
            </approved>
            <confirmed>
                <leadCount>0</leadCount>
                <leadCommission>0.0</leadCommission>
                <saleCount>0</saleCount>
                <saleCommission>0.0</saleCommission>
                <saleAmount>0.0</saleAmount>
            </confirmed>
            <rejected>
                <leadCount>0</leadCount>
                <leadCommission>0.0</leadCommission>
                <saleCount>0</saleCount>
                <saleCommission>0.0</saleCommission>
                <saleAmount>0.0</saleAmount>
            </rejected>
        </reportItem>
</GetReportBasicResponse>

 

Resource Information

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