Version 5.0
AdvertServe User Manual :: v5.0

Reports :: Accounting API Module

Modules

Income

Description

Allows you to generate an accounting income report.

Module URI

Hyperlink /servlet/control/api/reports/accounting/income

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2010-10-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2010-10-31 Must be a Date in yyyy-MM-dd format
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
advertiserIntegerNo123 Must be the ID# of an existing advertiser
publisherIntegerNo123 Must be the ID# of an existing publisher
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • json
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserDatabooleanNotrue Must be a boolean value equal to either true or false
campaignDatabooleanNotrue Must be a boolean value equal to either true or false
dailyDatabooleanNotrue Must be a boolean value equal to either true or false
groupDatabooleanNotrue Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
zoneDatabooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserOrdByStringNoa.name Must be a String equal to one of the following values:
  • a.id
  • a.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • flat_inc
  • subtotal_inc
  • ecpm_inc
advertiserSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
campaignOrdByStringNoc.name Must be a String equal to one of the following values:
  • c.id
  • c.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • flat_inc
  • subtotal_inc
  • ecpm_inc
campaignSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
dailyOrdByStringNodate Must be a String equal to one of the following values:
  • date
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • subtotal_inc
  • ecpm_inc
dailySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
groupOrdByStringNog.name Must be a String equal to one of the following values:
  • g.id
  • g.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • subtotal_inc
  • ecpm_inc
groupSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
publisherOrdByStringNop.name Must be a String equal to one of the following values:
  • p.id
  • p.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • subtotal_inc
  • ecpm_inc
publisherSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
zoneOrdByStringNoz.name Must be a String equal to one of the following values:
  • z.id
  • z.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_inc
  • cpc_inc
  • cpa_inc
  • subtotal_inc
  • ecpm_inc
zoneSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/accounting/income?secret=(key)&startDate=2009-01-01&stopDate=2009-06-30&advertiser=2&format=xml


<report id="accounting/income" startdate="2009-01-01" stopdate="2009-06-30" type="income">
  <criteria>
    <param name="Name" value="Accounting :: Income Summary"/>
    <param name="Advertiser" value="American Express"/>
    <param name="Start Date" value="January 1, 2009"/>
    <param name="Stop Date" value="June 30, 2009"/>
  </criteria>
  <description>This report shows a breakdown of income organized by advertiser, campaign, date, group, publisher, and zone.  By looking at this report, you can quickly see how much income you have generated throughout the selected date range.</description>
  <content>
    <section id="campaign" name="Campaign Summary">
      <fields>
        <field id="c.id" name="ID" format="number"/>
        <field id="c.name" name="Campaign" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_inc" name="CPM" format="currency"/>
        <field id="cpc_inc" name="CPC" format="currency"/>
        <field id="cpa_inc" name="CPA" format="currency"/>
        <field id="flat_inc" name="Flat" format="currency"/>
        <field id="subtotal_inc" name="Subtotal" format="currency"/>
        <field id="ecpm_inc" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="c.id" value="7"/>
          <column id="c.name" value="American Express 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.17"/>
          <column id="cpc_inc" value="$3.75"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$115.294"/>
        </row>
      </data>
      <averages>
        <average id="c.id" value="n/a"/>
        <average id="c.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="cpm_inc" value="$0.17"/>
        <average id="cpc_inc" value="$3.75"/>
        <average id="cpa_inc" value="$0.00"/>
        <average id="flat_inc" value="$0.00"/>
        <average id="subtotal_inc" value="$3.92"/>
        <average id="ecpm_inc" value="$115.294"/>
      </averages>
      <totals>
        <total id="c.id" value="n/a"/>
        <total id="c.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_inc" value="$0.17"/>
        <total id="cpc_inc" value="$3.75"/>
        <total id="cpa_inc" value="$0.00"/>
        <total id="flat_inc" value="$0.00"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$115.294"/>
      </totals>
    </section>
    <section id="daily" name="Daily Summary">
      <fields>
        <field id="date" name="Date" format="date"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_inc" name="CPM" format="currency"/>
        <field id="cpc_inc" name="CPC" format="currency"/>
        <field id="cpa_inc" name="CPA" format="currency"/>
        <field id="flat_inc" name="Flat" format="currency"/>
        <field id="subtotal_inc" name="Subtotal" format="currency"/>
        <field id="ecpm_inc" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="date" value="2009-01-14"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.02"/>
          <column id="cpc_inc" value="$0.00"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$0.02"/>
          <column id="ecpm_inc" value="$5.000"/>
        </row>
        <row>
          <column id="date" value="2009-01-26"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.04"/>
          <column id="cpc_inc" value="$0.00"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$0.04"/>
          <column id="ecpm_inc" value="$5.000"/>
        </row>
        <row>
          <column id="date" value="2009-01-27"/>
          <column id="sumviews" value="23"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.11"/>
          <column id="cpc_inc" value="$3.75"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$3.86"/>
          <column id="ecpm_inc" value="$168.043"/>
        </row>
        <row>
          <column id="date" value="2009-03-07"/>
          <column id="sumviews" value="5"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.00"/>
          <column id="cpc_inc" value="$0.00"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$0.00"/>
          <column id="ecpm_inc" value="$0.000"/>
        </row>
      </data>
      <averages>
        <average id="date" value="n/a"/>
        <average id="sumviews" value="10"/>
        <average id="cpm_inc" value="$0.04"/>
        <average id="cpc_inc" value="$0.94"/>
        <average id="cpa_inc" value="$0.00"/>
        <average id="flat_inc" value="$0.00"/>
        <average id="subtotal_inc" value="$0.98"/>
        <average id="ecpm_inc" value="$44.511"/>
      </averages>
      <totals>
        <total id="date" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_inc" value="$0.17"/>
        <total id="cpc_inc" value="$3.75"/>
        <total id="cpa_inc" value="$0.00"/>
        <total id="flat_inc" value="$0.00"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$100.513"/>
      </totals>
    </section>
    <section id="group" name="Group Summary">
      <fields>
        <field id="g.id" name="ID" format="number"/>
        <field id="g.name" name="Group" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_inc" name="CPM" format="currency"/>
        <field id="cpc_inc" name="CPC" format="currency"/>
        <field id="cpa_inc" name="CPA" format="currency"/>
        <field id="flat_inc" name="Flat" format="currency"/>
        <field id="subtotal_inc" name="Subtotal" format="currency"/>
        <field id="ecpm_inc" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="g.id" value="1"/>
          <column id="g.name" value="Default"/>
          <column id="sumviews" value="39"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.17"/>
          <column id="cpc_inc" value="$3.75"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$100.513"/>
        </row>
      </data>
      <averages>
        <average id="g.id" value="n/a"/>
        <average id="g.name" value="n/a"/>
        <average id="sumviews" value="39"/>
        <average id="cpm_inc" value="$0.17"/>
        <average id="cpc_inc" value="$3.75"/>
        <average id="cpa_inc" value="$0.00"/>
        <average id="flat_inc" value="$0.00"/>
        <average id="subtotal_inc" value="$3.92"/>
        <average id="ecpm_inc" value="$100.513"/>
      </averages>
      <totals>
        <total id="g.id" value="n/a"/>
        <total id="g.name" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_inc" value="$0.17"/>
        <total id="cpc_inc" value="$3.75"/>
        <total id="cpa_inc" value="$0.00"/>
        <total id="flat_inc" value="$0.00"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$100.513"/>
      </totals>
    </section>
    <section id="publisher" name="Publisher Summary"/>
    <section id="zone" name="Zone Summary">
      <fields>
        <field id="z.id" name="ID" format="number"/>
        <field id="z.name" name="Zone" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_inc" name="CPM" format="currency"/>
        <field id="cpc_inc" name="CPC" format="currency"/>
        <field id="cpa_inc" name="CPA" format="currency"/>
        <field id="flat_inc" name="Flat" format="currency"/>
        <field id="subtotal_inc" name="Subtotal" format="currency"/>
        <field id="ecpm_inc" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="z.id" value="3"/>
          <column id="z.name" value="Articles Banner / 468x60"/>
          <column id="sumviews" value="5"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.00"/>
          <column id="cpc_inc" value="$0.00"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$0.00"/>
          <column id="ecpm_inc" value="$0.000"/>
        </row>
        <row>
          <column id="z.id" value="7"/>
          <column id="z.name" value="Articles Skyscraper / 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_inc" value="$0.17"/>
          <column id="cpc_inc" value="$3.75"/>
          <column id="cpa_inc" value="$0.00"/>
          <column id="flat_inc" value="$0.00"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$115.294"/>
        </row>
      </data>
      <averages>
        <average id="z.id" value="n/a"/>
        <average id="z.name" value="n/a"/>
        <average id="sumviews" value="20"/>
        <average id="cpm_inc" value="$0.08"/>
        <average id="cpc_inc" value="$1.88"/>
        <average id="cpa_inc" value="$0.00"/>
        <average id="flat_inc" value="$0.00"/>
        <average id="subtotal_inc" value="$1.96"/>
        <average id="ecpm_inc" value="$57.647"/>
      </averages>
      <totals>
        <total id="z.id" value="n/a"/>
        <total id="z.name" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_inc" value="$0.17"/>
        <total id="cpc_inc" value="$3.75"/>
        <total id="cpa_inc" value="$0.00"/>
        <total id="flat_inc" value="$0.00"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$100.513"/>
      </totals>
    </section>
  </content>
</report>

Expense

Description

Allows you to generate an accounting expense report.

Module URI

Hyperlink /servlet/control/api/reports/accounting/expense

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2010-10-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2010-10-31 Must be a Date in yyyy-MM-dd format
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
advertiserIntegerNo123 Must be the ID# of an existing advertiser
publisherIntegerNo123 Must be the ID# of an existing publisher
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • json
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserDatabooleanNotrue Must be a boolean value equal to either true or false
campaignDatabooleanNotrue Must be a boolean value equal to either true or false
dailyDatabooleanNotrue Must be a boolean value equal to either true or false
groupDatabooleanNotrue Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
zoneDatabooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserOrdByStringNoa.name Must be a String equal to one of the following values:
  • a.id
  • a.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • flat_exp
  • subtotal_exp
  • ecpm_exp
advertiserSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
campaignOrdByStringNoc.name Must be a String equal to one of the following values:
  • c.id
  • c.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • flat_exp
  • subtotal_exp
  • ecpm_exp
campaignSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
dailyOrdByStringNodate Must be a String equal to one of the following values:
  • date
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • subtotal_exp
  • ecpm_exp
dailySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
groupOrdByStringNog.name Must be a String equal to one of the following values:
  • g.id
  • g.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • subtotal_exp
  • ecpm_exp
groupSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
publisherOrdByStringNop.name Must be a String equal to one of the following values:
  • p.id
  • p.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • subtotal_exp
  • ecpm_exp
publisherSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
zoneOrdByStringNoz.name Must be a String equal to one of the following values:
  • z.id
  • z.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_exp
  • cpc_exp
  • cpa_exp
  • subtotal_exp
  • ecpm_exp
zoneSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/accounting/expense?secret=(key)&startDate=2009-01-01&stopDate=2009-06-30&advertiser=2&format=xml


<report id="accounting/expense" startdate="2009-01-01" stopdate="2009-06-30" type="expense">
  <criteria>
    <param name="Name" value="Accounting :: Expense Summary"/>
    <param name="Advertiser" value="American Express"/>
    <param name="Start Date" value="January 1, 2009"/>
    <param name="Stop Date" value="June 30, 2009"/>
  </criteria>
  <description>This report shows a breakdown of expenses organized by advertiser, campaign, date, group, publisher, and zone.  By looking at this report, you can quickly see how much cost you have incurred throughout the selected date range.</description>
  <content>
    <section id="campaign" name="Campaign Summary">
      <fields>
        <field id="c.id" name="ID" format="number"/>
        <field id="c.name" name="Campaign" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_exp" name="CPM" format="currency"/>
        <field id="cpc_exp" name="CPC" format="currency"/>
        <field id="cpa_exp" name="CPA" format="currency"/>
        <field id="flat_exp" name="Flat" format="currency"/>
        <field id="subtotal_exp" name="Subtotal" format="currency"/>
        <field id="ecpm_exp" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="c.id" value="7"/>
          <column id="c.name" value="American Express 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.12"/>
          <column id="cpc_exp" value="$2.25"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$69.676"/>
        </row>
      </data>
      <averages>
        <average id="c.id" value="n/a"/>
        <average id="c.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="cpm_exp" value="$0.12"/>
        <average id="cpc_exp" value="$2.25"/>
        <average id="cpa_exp" value="$0.00"/>
        <average id="flat_exp" value="$0.00"/>
        <average id="subtotal_exp" value="$2.37"/>
        <average id="ecpm_exp" value="$69.676"/>
      </averages>
      <totals>
        <total id="c.id" value="n/a"/>
        <total id="c.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_exp" value="$0.12"/>
        <total id="cpc_exp" value="$2.25"/>
        <total id="cpa_exp" value="$0.00"/>
        <total id="flat_exp" value="$0.00"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$69.676"/>
      </totals>
    </section>
    <section id="daily" name="Daily Summary">
      <fields>
        <field id="date" name="Date" format="date"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_exp" name="CPM" format="currency"/>
        <field id="cpc_exp" name="CPC" format="currency"/>
        <field id="cpa_exp" name="CPA" format="currency"/>
        <field id="flat_exp" name="Flat" format="currency"/>
        <field id="subtotal_exp" name="Subtotal" format="currency"/>
        <field id="ecpm_exp" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="date" value="2009-01-14"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.01"/>
          <column id="cpc_exp" value="$0.00"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$0.01"/>
          <column id="ecpm_exp" value="$3.500"/>
        </row>
        <row>
          <column id="date" value="2009-01-26"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.03"/>
          <column id="cpc_exp" value="$0.00"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$0.03"/>
          <column id="ecpm_exp" value="$3.500"/>
        </row>
        <row>
          <column id="date" value="2009-01-27"/>
          <column id="sumviews" value="23"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.08"/>
          <column id="cpc_exp" value="$2.25"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$2.33"/>
          <column id="ecpm_exp" value="$101.326"/>
        </row>
        <row>
          <column id="date" value="2009-03-07"/>
          <column id="sumviews" value="5"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.00"/>
          <column id="cpc_exp" value="$0.00"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$0.00"/>
          <column id="ecpm_exp" value="$0.000"/>
        </row>
      </data>
      <averages>
        <average id="date" value="n/a"/>
        <average id="sumviews" value="10"/>
        <average id="cpm_exp" value="$0.03"/>
        <average id="cpc_exp" value="$0.56"/>
        <average id="cpa_exp" value="$0.00"/>
        <average id="flat_exp" value="$0.00"/>
        <average id="subtotal_exp" value="$0.59"/>
        <average id="ecpm_exp" value="$27.082"/>
      </averages>
      <totals>
        <total id="date" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_exp" value="$0.12"/>
        <total id="cpc_exp" value="$2.25"/>
        <total id="cpa_exp" value="$0.00"/>
        <total id="flat_exp" value="$0.00"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$60.744"/>
      </totals>
    </section>
    <section id="group" name="Group Summary">
      <fields>
        <field id="g.id" name="ID" format="number"/>
        <field id="g.name" name="Group" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_exp" name="CPM" format="currency"/>
        <field id="cpc_exp" name="CPC" format="currency"/>
        <field id="cpa_exp" name="CPA" format="currency"/>
        <field id="flat_exp" name="Flat" format="currency"/>
        <field id="subtotal_exp" name="Subtotal" format="currency"/>
        <field id="ecpm_exp" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="g.id" value="1"/>
          <column id="g.name" value="Default"/>
          <column id="sumviews" value="39"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.12"/>
          <column id="cpc_exp" value="$2.25"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$60.744"/>
        </row>
      </data>
      <averages>
        <average id="g.id" value="n/a"/>
        <average id="g.name" value="n/a"/>
        <average id="sumviews" value="39"/>
        <average id="cpm_exp" value="$0.12"/>
        <average id="cpc_exp" value="$2.25"/>
        <average id="cpa_exp" value="$0.00"/>
        <average id="flat_exp" value="$0.00"/>
        <average id="subtotal_exp" value="$2.37"/>
        <average id="ecpm_exp" value="$60.744"/>
      </averages>
      <totals>
        <total id="g.id" value="n/a"/>
        <total id="g.name" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_exp" value="$0.12"/>
        <total id="cpc_exp" value="$2.25"/>
        <total id="cpa_exp" value="$0.00"/>
        <total id="flat_exp" value="$0.00"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$60.744"/>
      </totals>
    </section>
    <section id="publisher" name="Publisher Summary"/>
    <section id="zone" name="Zone Summary">
      <fields>
        <field id="z.id" name="ID" format="number"/>
        <field id="z.name" name="Zone" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_exp" name="CPM" format="currency"/>
        <field id="cpc_exp" name="CPC" format="currency"/>
        <field id="cpa_exp" name="CPA" format="currency"/>
        <field id="flat_exp" name="Flat" format="currency"/>
        <field id="subtotal_exp" name="Subtotal" format="currency"/>
        <field id="ecpm_exp" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="z.id" value="3"/>
          <column id="z.name" value="Articles Banner / 468x60"/>
          <column id="sumviews" value="5"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.00"/>
          <column id="cpc_exp" value="$0.00"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$0.00"/>
          <column id="ecpm_exp" value="$0.000"/>
        </row>
        <row>
          <column id="z.id" value="7"/>
          <column id="z.name" value="Articles Skyscraper / 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_exp" value="$0.12"/>
          <column id="cpc_exp" value="$2.25"/>
          <column id="cpa_exp" value="$0.00"/>
          <column id="flat_exp" value="$0.00"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$69.676"/>
        </row>
      </data>
      <averages>
        <average id="z.id" value="n/a"/>
        <average id="z.name" value="n/a"/>
        <average id="sumviews" value="20"/>
        <average id="cpm_exp" value="$0.06"/>
        <average id="cpc_exp" value="$1.12"/>
        <average id="cpa_exp" value="$0.00"/>
        <average id="flat_exp" value="$0.00"/>
        <average id="subtotal_exp" value="$1.18"/>
        <average id="ecpm_exp" value="$34.838"/>
      </averages>
      <totals>
        <total id="z.id" value="n/a"/>
        <total id="z.name" value="n/a"/>
        <total id="sumviews" value="39"/>
        <total id="cpm_exp" value="$0.12"/>
        <total id="cpc_exp" value="$2.25"/>
        <total id="cpa_exp" value="$0.00"/>
        <total id="flat_exp" value="$0.00"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$60.744"/>
      </totals>
    </section>
  </content>
</report>

Profit

Description

Allows you to generate an accounting profit report.

Module URI

Hyperlink /servlet/control/api/reports/accounting/profit

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2010-10-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2010-10-31 Must be a Date in yyyy-MM-dd format
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
advertiserIntegerNo123 Must be the ID# of an existing advertiser
publisherIntegerNo123 Must be the ID# of an existing publisher
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • json
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserDatabooleanNotrue Must be a boolean value equal to either true or false
campaignDatabooleanNotrue Must be a boolean value equal to either true or false
dailyDatabooleanNotrue Must be a boolean value equal to either true or false
groupDatabooleanNotrue Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
zoneDatabooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • flat_pft
  • subtotal_pft
  • ecpm_pft
advertiserSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
campaignOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • flat_pft
  • subtotal_pft
  • ecpm_pft
campaignSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
dailyOrdByStringNori.date Must be a String equal to one of the following values:
  • ri.date
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • subtotal_pft
  • ecpm_pft
dailySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
groupOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • subtotal_pft
  • ecpm_pft
groupSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
publisherOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • subtotal_pft
  • ecpm_pft
publisherSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
zoneOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • cpm_pft
  • cpc_pft
  • cpa_pft
  • subtotal_pft
  • ecpm_pft
zoneSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/accounting/profit?secret=(key)&startDate=2009-01-01&stopDate=2009-06-30&advertiser=2&format=xml


<report id="accounting/profit" startdate="2009-01-01" stopdate="2009-06-30" type="profit">
  <criteria>
    <param name="Name" value="Accounting :: Profit Summary"/>
    <param name="Advertiser" value="American Express"/>
    <param name="Start Date" value="January 1, 2009"/>
    <param name="Stop Date" value="June 30, 2009"/>
  </criteria>
  <description>This report shows a breakdown of profit organized by advertiser, campaign, date, group, publisher, and zone.  By looking at this report, you can quickly see how much profit you have generated throughout the selected date range.</description>
  <content>
    <section id="campaign" name="Campaign Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Campaign" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_pft" name="CPM" format="currency"/>
        <field id="cpc_pft" name="CPC" format="currency"/>
        <field id="cpa_pft" name="CPA" format="currency"/>
        <field id="flat_pft" name="Flat" format="currency"/>
        <field id="subtotal_pft" name="Subtotal" format="currency"/>
        <field id="ecpm_pft" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="7"/>
          <column id="ri.name" value="American Express 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.05"/>
          <column id="cpc_pft" value="$1.50"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="cpm_pft" value="$0.05"/>
        <average id="cpc_pft" value="$1.50"/>
        <average id="cpa_pft" value="$0.00"/>
        <average id="flat_pft" value="$0.00"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_pft" value="$0.05"/>
        <total id="cpc_pft" value="$1.50"/>
        <total id="cpa_pft" value="$0.00"/>
        <total id="flat_pft" value="$0.00"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="daily" name="Daily Summary">
      <fields>
        <field id="ri.date" name="Date" format="date"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_pft" name="CPM" format="currency"/>
        <field id="cpc_pft" name="CPC" format="currency"/>
        <field id="cpa_pft" name="CPA" format="currency"/>
        <field id="flat_pft" name="Flat" format="currency"/>
        <field id="subtotal_pft" name="Subtotal" format="currency"/>
        <field id="ecpm_pft" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.date" value="2009-01-14"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.00"/>
          <column id="cpc_pft" value="$0.00"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$0.00"/>
          <column id="ecpm_pft" value="$1.500"/>
        </row>
        <row>
          <column id="ri.date" value="2009-01-26"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.01"/>
          <column id="cpc_pft" value="$0.00"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$0.01"/>
          <column id="ecpm_pft" value="$1.500"/>
        </row>
        <row>
          <column id="ri.date" value="2009-01-27"/>
          <column id="sumviews" value="23"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.03"/>
          <column id="cpc_pft" value="$1.50"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$1.53"/>
          <column id="ecpm_pft" value="$66.717"/>
        </row>
      </data>
      <averages>
        <average id="ri.date" value="n/a"/>
        <average id="sumviews" value="11"/>
        <average id="cpm_pft" value="$0.02"/>
        <average id="cpc_pft" value="$0.50"/>
        <average id="cpa_pft" value="$0.00"/>
        <average id="flat_pft" value="$0.00"/>
        <average id="subtotal_pft" value="$0.52"/>
        <average id="ecpm_pft" value="$23.239"/>
      </averages>
      <totals>
        <total id="ri.date" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_pft" value="$0.05"/>
        <total id="cpc_pft" value="$1.50"/>
        <total id="cpa_pft" value="$0.00"/>
        <total id="flat_pft" value="$0.00"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="group" name="Group Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Group" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_pft" name="CPM" format="currency"/>
        <field id="cpc_pft" name="CPC" format="currency"/>
        <field id="cpa_pft" name="CPA" format="currency"/>
        <field id="flat_pft" name="Flat" format="currency"/>
        <field id="subtotal_pft" name="Subtotal" format="currency"/>
        <field id="ecpm_pft" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="1"/>
          <column id="ri.name" value="Default"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.05"/>
          <column id="cpc_pft" value="$1.50"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="cpm_pft" value="$0.05"/>
        <average id="cpc_pft" value="$1.50"/>
        <average id="cpa_pft" value="$0.00"/>
        <average id="flat_pft" value="$0.00"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_pft" value="$0.05"/>
        <total id="cpc_pft" value="$1.50"/>
        <total id="cpa_pft" value="$0.00"/>
        <total id="flat_pft" value="$0.00"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="publisher" name="Publisher Summary"/>
    <section id="zone" name="Zone Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Zone" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="cpm_pft" name="CPM" format="currency"/>
        <field id="cpc_pft" name="CPC" format="currency"/>
        <field id="cpa_pft" name="CPA" format="currency"/>
        <field id="flat_pft" name="Flat" format="currency"/>
        <field id="subtotal_pft" name="Subtotal" format="currency"/>
        <field id="ecpm_pft" name="eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="7"/>
          <column id="ri.name" value="Articles Skyscraper / 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="cpm_pft" value="$0.05"/>
          <column id="cpc_pft" value="$1.50"/>
          <column id="cpa_pft" value="$0.00"/>
          <column id="flat_pft" value="$0.00"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="cpm_pft" value="$0.05"/>
        <average id="cpc_pft" value="$1.50"/>
        <average id="cpa_pft" value="$0.00"/>
        <average id="flat_pft" value="$0.00"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="cpm_pft" value="$0.05"/>
        <total id="cpc_pft" value="$1.50"/>
        <total id="cpa_pft" value="$0.00"/>
        <total id="flat_pft" value="$0.00"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
  </content>
</report>

Summary

Description

Allows you to generate an accounting summary report.

Module URI

Hyperlink /servlet/control/api/reports/accounting/summary

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2010-10-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2010-10-31 Must be a Date in yyyy-MM-dd format
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
advertiserIntegerNo123 Must be the ID# of an existing advertiser
publisherIntegerNo123 Must be the ID# of an existing publisher
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • json
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserDatabooleanNotrue Must be a boolean value equal to either true or false
campaignDatabooleanNotrue Must be a boolean value equal to either true or false
dailyDatabooleanNotrue Must be a boolean value equal to either true or false
groupDatabooleanNotrue Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
zoneDatabooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
advertiserSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
campaignOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
campaignSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
dailyOrdByStringNori.date Must be a String equal to one of the following values:
  • ri.date
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
dailySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
groupOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
groupSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
publisherOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
publisherSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
zoneOrdByStringNori.name Must be a String equal to one of the following values:
  • ri.id
  • ri.name
  • sumviews
  • sumclicks
  • sumactions
  • subtotal_inc
  • ecpm_inc
  • subtotal_exp
  • ecpm_exp
  • subtotal_pft
  • ecpm_pft
zoneSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/accounting/summary?secret=(key)&startDate=2009-01-01&stopDate=2009-06-30&advertiser=2&format=xml


<report id="accounting/summary" startdate="2009-01-01" stopdate="2009-06-30" type="summary">
  <criteria>
    <param name="Name" value="Accounting :: Overall Summary"/>
    <param name="Advertiser" value="American Express"/>
    <param name="Start Date" value="January 1, 2009"/>
    <param name="Stop Date" value="June 30, 2009"/>
  </criteria>
  <description>This report shows a breakdown of income, expenses, and profit organized by advertiser, campaign, date, group, publisher, and zone.  By looking at this report, you can quickly see how much income, expenses, and profit you have generated throughout the selected date range.</description>
  <content>
    <section id="campaign" name="Campaign Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Campaign" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="subtotal_inc" name="Income" format="currency"/>
        <field id="ecpm_inc" name="Income eCPM" format="currency"/>
        <field id="subtotal_exp" name="Expense" format="currency"/>
        <field id="ecpm_exp" name="Expense eCPM" format="currency"/>
        <field id="subtotal_pft" name="Profit" format="currency"/>
        <field id="ecpm_pft" name="Profit eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="7"/>
          <column id="ri.name" value="American Express 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$115.294"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$69.676"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="subtotal_inc" value="$3.92"/>
        <average id="ecpm_inc" value="$115.294"/>
        <average id="subtotal_exp" value="$2.37"/>
        <average id="ecpm_exp" value="$69.676"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$115.294"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$69.676"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="daily" name="Daily Summary">
      <fields>
        <field id="ri.date" name="Date" format="date"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="subtotal_inc" name="Income" format="currency"/>
        <field id="ecpm_inc" name="Income eCPM" format="currency"/>
        <field id="subtotal_exp" name="Expense" format="currency"/>
        <field id="ecpm_exp" name="Expense eCPM" format="currency"/>
        <field id="subtotal_pft" name="Profit" format="currency"/>
        <field id="ecpm_pft" name="Profit eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.date" value="2009-01-14"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$0.02"/>
          <column id="ecpm_inc" value="$5.000"/>
          <column id="subtotal_exp" value="$0.01"/>
          <column id="ecpm_exp" value="$3.500"/>
          <column id="subtotal_pft" value="$0.00"/>
          <column id="ecpm_pft" value="$1.500"/>
        </row>
        <row>
          <column id="ri.date" value="2009-01-26"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$0.04"/>
          <column id="ecpm_inc" value="$5.000"/>
          <column id="subtotal_exp" value="$0.03"/>
          <column id="ecpm_exp" value="$3.500"/>
          <column id="subtotal_pft" value="$0.01"/>
          <column id="ecpm_pft" value="$1.500"/>
        </row>
        <row>
          <column id="ri.date" value="2009-01-27"/>
          <column id="sumviews" value="23"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$3.87"/>
          <column id="ecpm_inc" value="$168.043"/>
          <column id="subtotal_exp" value="$2.33"/>
          <column id="ecpm_exp" value="$101.326"/>
          <column id="subtotal_pft" value="$1.53"/>
          <column id="ecpm_pft" value="$66.717"/>
        </row>
      </data>
      <averages>
        <average id="ri.date" value="n/a"/>
        <average id="sumviews" value="11"/>
        <average id="subtotal_inc" value="$1.31"/>
        <average id="ecpm_inc" value="$59.348"/>
        <average id="subtotal_exp" value="$0.79"/>
        <average id="ecpm_exp" value="$36.109"/>
        <average id="subtotal_pft" value="$0.52"/>
        <average id="ecpm_pft" value="$23.239"/>
      </averages>
      <totals>
        <total id="ri.date" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$115.294"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$69.676"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="group" name="Group Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Group" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="subtotal_inc" name="Income" format="currency"/>
        <field id="ecpm_inc" name="Income eCPM" format="currency"/>
        <field id="subtotal_exp" name="Expense" format="currency"/>
        <field id="ecpm_exp" name="Expense eCPM" format="currency"/>
        <field id="subtotal_pft" name="Profit" format="currency"/>
        <field id="ecpm_pft" name="Profit eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="1"/>
          <column id="ri.name" value="Default"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$115.294"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$69.676"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="subtotal_inc" value="$3.92"/>
        <average id="ecpm_inc" value="$115.294"/>
        <average id="subtotal_exp" value="$2.37"/>
        <average id="ecpm_exp" value="$69.676"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$115.294"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$69.676"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
    <section id="publisher" name="Publisher Summary"/>
    <section id="zone" name="Zone Summary">
      <fields>
        <field id="ri.id" name="ID" format="number"/>
        <field id="ri.name" name="Zone" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="subtotal_inc" name="Income" format="currency"/>
        <field id="ecpm_inc" name="Income eCPM" format="currency"/>
        <field id="subtotal_exp" name="Expense" format="currency"/>
        <field id="ecpm_exp" name="Expense eCPM" format="currency"/>
        <field id="subtotal_pft" name="Profit" format="currency"/>
        <field id="ecpm_pft" name="Profit eCPM" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="ri.id" value="7"/>
          <column id="ri.name" value="Articles Skyscraper / 120x600"/>
          <column id="sumviews" value="34"/>
          <column id="sumclicks" value="0"/>
          <column id="sumactions" value="0"/>
          <column id="subtotal_inc" value="$3.92"/>
          <column id="ecpm_inc" value="$115.294"/>
          <column id="subtotal_exp" value="$2.37"/>
          <column id="ecpm_exp" value="$69.676"/>
          <column id="subtotal_pft" value="$1.55"/>
          <column id="ecpm_pft" value="$45.618"/>
        </row>
      </data>
      <averages>
        <average id="ri.id" value="n/a"/>
        <average id="ri.name" value="n/a"/>
        <average id="sumviews" value="34"/>
        <average id="sumclicks" value="0"/>
        <average id="sumactions" value="0"/>
        <average id="subtotal_inc" value="$3.92"/>
        <average id="ecpm_inc" value="$115.294"/>
        <average id="subtotal_exp" value="$2.37"/>
        <average id="ecpm_exp" value="$69.676"/>
        <average id="subtotal_pft" value="$1.55"/>
        <average id="ecpm_pft" value="$45.618"/>
      </averages>
      <totals>
        <total id="ri.id" value="n/a"/>
        <total id="ri.name" value="n/a"/>
        <total id="sumviews" value="34"/>
        <total id="sumclicks" value="0"/>
        <total id="sumactions" value="0"/>
        <total id="subtotal_inc" value="$3.92"/>
        <total id="ecpm_inc" value="$115.294"/>
        <total id="subtotal_exp" value="$2.37"/>
        <total id="ecpm_exp" value="$69.676"/>
        <total id="subtotal_pft" value="$1.55"/>
        <total id="ecpm_pft" value="$45.618"/>
      </totals>
    </section>
  </content>
</report>