Version 5.0
AdvertServe User Manual :: v5.0

Reports :: Campaigns API Module

Modules

Conversions

Description

Allows you to generate a campaign conversions report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/conversions

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • conversions
  • converted_view_events
  • converted_views
  • converted_click_events
  • converted_clicks
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/conversions?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/conversions" startdate="2016-01-01" stopdate="2016-01-31" type="conversions">
  <criteria>
    <param name="Name" value="Conversions Summary"/>
    <param name="Campaign" value="ACME 468x60"/>
    <param name="Start Date" value="January 1, 2016"/>
    <param name="Stop Date" value="January 31, 2016"/>
  </criteria>
  <description>This report provides more detailed insight into conversion actions by comparing view-through conversions and click-through conversions.</description>
  <content>
    <section id="conversions" name="Conversions Summary">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media Name" format="none"/>
        <field id="conversions" name="Conversions" format="number"/>
        <field id="converted_view_events" name="View-Through Conversions" format="number"/>
        <field id="converted_views" name="View-Through Percentage" format="percentage"/>
        <field id="converted_click_events" name="Click-Through Conversions" format="number"/>
        <field id="converted_clicks" name="Click-Through Percentage" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="7"/>
          <column id="m.name" value="ACME 468x60"/>
          <column id="conversions" value="1"/>
          <column id="converted_view_events" value="0"/>
          <column id="converted_views" value="0.00%"/>
          <column id="converted_click_events" value="1"/>
          <column id="converted_clicks" value="100.00%"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="conversions" value="1"/>
        <average id="converted_view_events" value="0"/>
        <average id="converted_views" value="0.00%"/>
        <average id="converted_click_events" value="1"/>
        <average id="converted_clicks" value="100.00%"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="conversions" value="1"/>
        <total id="converted_view_events" value="0"/>
        <total id="converted_views" value="0.00%"/>
        <total id="converted_click_events" value="1"/>
        <total id="converted_clicks" value="100.00%"/>
      </totals>
    </section>
  </content>
</report>

Custom

Description

Allows you to generate a campaign custom field report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/custom

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
typeStringYescustom1 Must be a String equal to one of the following values:
  • custom1
  • custom2
  • custom3
  • custom4
  • custom5
  • custom6
  • custom7
  • custom8
  • custom9
  • custom10
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • data
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/custom?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&type=custom1&format=xml


<report id="campaigns/custom" startdate="2010-10-30" stopdate="2010-10-30" type="custom1">
  <criteria>
    <param name="Name" value="Custom Field Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by data input with a custom field.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different data inputs throughout the selected date range.</description>
  <content>
    <section id="custom1" name="Custom Field Summary">
      <fields>
        <field id="data" name="Custom Field #1" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="data" value="forums"/>
          <column id="share" value="38.24%"/>
          <column id="sumviews" value="26"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="home"/>
          <column id="share" value="23.53%"/>
          <column id="sumviews" value="16"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="6.25%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="support"/>
          <column id="share" value="19.12%"/>
          <column id="sumviews" value="13"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="contact"/>
          <column id="share" value="5.88%"/>
          <column id="sumviews" value="4"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="customers"/>
          <column id="share" value="4.41%"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="company"/>
          <column id="share" value="4.41%"/>
          <column id="sumviews" value="3"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="solutions"/>
          <column id="share" value="2.94%"/>
          <column id="sumviews" value="2"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="data" value="partners"/>
          <column id="share" value="1.47%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="data" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="9"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.01%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="data" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="68"/>
        <total id="sumclicks" value="1"/>
        <total id="clickratio" value="0.01%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Daily

Description

Allows you to generate a campaign daily report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/daily

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
orderByStringNodate Must be a String equal to one of the following values:
  • date
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/daily?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/daily" startdate="2010-10-30" stopdate="2010-10-30" type="daily">
  <criteria>
    <param name="Name" value="Daily Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a daily breakdown of impressions, clicks, and actions.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered throughout the selected date range.</description>
  <content>
    <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="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="date" value="2010-10-30"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="date" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="date" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Events

Description

Allows you to generate a campaign events report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/events

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2016-01-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2016-12-31 Must be a Date in yyyy-MM-dd format
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
counterOrderByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • event_count
  • triggered_rate
counterSortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
exitOrderByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • event_count
  • triggered_rate
exitSortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
videoOrderByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • start_events
  • start
  • first_quartile_events
  • first_quartile
  • midpoint_events
  • midpoint
  • third_quartile_events
  • third_quartile
  • complete_events
  • complete
  • replay_events
  • replay
  • pause_events
  • pause
  • resume_events
  • resume
  • mute_events
  • mute
  • unmute_events
  • unmute
  • fullscreen_events
  • fullscreen
  • skip_events
  • skip
  • close_events
  • close
videoSortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/events?secret=(key)&startDate=2016-01-01&stopDate=2016-12-31&campaign=123&format=xml


<report id="campaigns/events" startdate="2016-01-01" stopdate="2016-12-31" type="events">
  <criteria>
    <param name="Name" value="Events Summary"/>
    <param name="Campaign" value="American Express 468x60"/>
    <param name="Start Date" value="January 1, 2016"/>
    <param name="Stop Date" value="December 31, 2016"/>
  </criteria>
  <description>This report provides an overview of counter, exit and video events that are tracked for rich media creatives, which is useful to gather insights to aid in optimizing creatives for better performance.</description>
  <content>
    <section id="events_counter" name="Events Summary - Counter">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media Name" format="none"/>
        <field id="event_name" name="Event Name" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="event_count" name="Event Count" format="number"/>
        <field id="triggered_rate" name="Triggered Rate" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="9"/>
          <column id="m.name" value="American Express 468x60"/>
          <column id="event_name" value="Close Button"/>
          <column id="sumviews" value="14"/>
          <column id="event_count" value="1"/>
          <column id="triggered_rate" value="7.14%"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="event_name" value="n/a"/>
        <average id="sumviews" value="14"/>
        <average id="event_count" value="1"/>
        <average id="triggered_rate" value="7.14%"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="event_name" value="n/a"/>
        <total id="sumviews" value="14"/>
        <total id="event_count" value="1"/>
        <total id="triggered_rate" value="7.14%"/>
      </totals>
    </section>
  </content>
</report>

Geography

Description

Allows you to generate a campaign geography report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/geography

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
typeStringYescontinent Must be a String equal to one of the following values:
  • continent
  • country
  • postal
  • state
  • statecity
  • dma
  • timezone
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • continent: g.id, g.name, sumviews, sumclicks, clickratio, sumactions, actionratio
  • country: g.id, g.name, sumviews, sumclicks, clickratio, sumactions, actionratio
  • postal: c.id, c.name, s.postal, sumviews, sumclicks, clickratio, sumactions, actionratio
  • state: state, sumviews, sumclicks, clickratio, sumactions, actionratio
  • statecity: c.id, c.name, s.state, s.city, sumviews, sumclicks, clickratio, sumactions, actionratio
  • dma: cc.name, g.id, g.name, sumviews, sumclicks, clickratio, sumactions, actionratio
  • timezone: g.id, g.name, sumviews, sumclicks, clickratio, sumactions, actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/geography?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&type=continent&format=xml


<report id="campaigns/geography" startdate="2010-10-30" stopdate="2010-10-30" type="continent">
  <criteria>
    <param name="Name" value="Geography :: Continent Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by continent.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different continents throughout the selected date range.</description>
  <content>
    <section id="continent" name="Geography :: Continent Summary">
      <fields>
        <field id="g.id" name="ID" format="number"/>
        <field id="g.name" name="Continent" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="g.id" value="6"/>
          <column id="g.name" value="North America"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="g.id" value="n/a"/>
        <average id="g.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="g.id" value="n/a"/>
        <total id="g.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Hourly

Description

Allows you to generate a campaign hourly report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/hourly

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNohour Must be a String equal to one of the following values:
  • hour
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/hourly?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/hourly" startdate="2010-10-30" stopdate="2010-10-30" type="hourly">
  <criteria>
    <param name="Name" value="Hourly Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows an hourly breakdown of impressions, clicks, and actions.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered throughout the selected date range by time of day.</description>
  <content>
    <section id="hourly" name="Hourly Summary">
      <fields>
        <field id="hour" name="Hour" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="hour" value="12:00 - 12:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="01:00 - 01:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="02:00 - 02:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="03:00 - 03:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="04:00 - 04:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="05:00 - 05:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="06:00 - 06:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="07:00 - 07:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="08:00 - 08:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="09:00 - 09:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="10:00 - 10:59 AM"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="11:00 - 11:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="12:00 - 12:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="01:00 - 01:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="02:00 - 02:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="03:00 - 03:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="04:00 - 04:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="05:00 - 05:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="06:00 - 06:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="07:00 - 07:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="08:00 - 08:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="09:00 - 09:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="10:00 - 10:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="11:00 - 11:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="hour" value="n/a"/>
        <average id="sumviews" value="3"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="hour" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Interactive

Description

Allows you to generate an campaign interactive report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/interactive

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2016-01-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2016-12-31 Must be a Date in yyyy-MM-dd format
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
orderByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • sumviews
  • interactive_views
  • interactive_view_events
  • interactive_time
  • average_interactive_time
  • sumclicks
  • interactive_clicks
  • expanded_views
  • expanded_view_events
  • expanded_time
  • average_expanded_time
  • engaged_events
  • engaged
  • unique_engaged_events
  • unique_engaged
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/interactive?secret=(key)&startDate=2016-01-01&stopDate=2016-12-31&campaign=123&format=xml


<report id="campaigns/interactive" startdate="2016-01-01" stopdate="2016-12-31" type="interactive">
  <criteria>
    <param name="Name" value="Interactive Summary"/>
    <param name="Campaign" value="American Express 468x60"/>
    <param name="Start Date" value="January 1, 2016"/>
    <param name="Stop Date" value="December 31, 2016"/>
  </criteria>
  <description>This report provides various insights into how users are interacting and engaging with creatives.  Interactive impressions are counted when a user mouses over a creative for at least 1 second, expands it or clicks on it.  Expanded impressions are counted when a user expands a creative for at least 1 second.</description>
  <content>
    <section id="interactive" name="Interactive Summary">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media Name" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="interactive_view_events" name="Interactive Views" format="number"/>
        <field id="interactive_views" name="Interactive Rate" format="percentage"/>
        <field id="interactive_time" name="Interactive Time" format="interval"/>
        <field id="average_interactive_time" name="Average Interactive Time" format="interval"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="interactive_clicks" name="Interactive CTR" format="percentage"/>
        <field id="expanded_view_events" name="Expanded Views" format="number"/>
        <field id="expanded_views" name="Expanded Rate" format="percentage"/>
        <field id="expanded_time" name="Expanded Time" format="interval"/>
        <field id="average_expanded_time" name="Average Expanded Time" format="interval"/>
        <field id="engaged_events" name="Total Engagements" format="number"/>
        <field id="engaged" name="Engagement Rate" format="percentage"/>
        <field id="unique_engaged_events" name="Unique Engagements" format="number"/>
        <field id="unique_engaged" name="Unique Engagement Rate" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="9"/>
          <column id="m.name" value="American Express 468x60"/>
          <column id="sumviews" value="9"/>
          <column id="interactive_view_events" value="8"/>
          <column id="interactive_views" value="88.89%"/>
          <column id="interactive_time" value="22s"/>
          <column id="average_interactive_time" value="2.8s"/>
          <column id="sumclicks" value="2"/>
          <column id="interactive_clicks" value="4.76%"/>
          <column id="expanded_view_events" value="0"/>
          <column id="expanded_views" value="0.00%"/>
          <column id="expanded_time" value="0s"/>
          <column id="average_expanded_time" value="0s"/>
          <column id="engaged_events" value="0"/>
          <column id="engaged" value="0.00%"/>
          <column id="unique_engaged_events" value="0"/>
          <column id="unique_engaged" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="sumviews" value="9"/>
        <average id="interactive_view_events" value="8"/>
        <average id="interactive_views" value="88.89%"/>
        <average id="interactive_time" value="22s"/>
        <average id="average_interactive_time" value="2.8s"/>
        <average id="sumclicks" value="2"/>
        <average id="interactive_clicks" value="7.69%"/>
        <average id="expanded_view_events" value="0"/>
        <average id="expanded_views" value="0.00%"/>
        <average id="expanded_time" value="0s"/>
        <average id="average_expanded_time" value="0s"/>
        <average id="engaged_events" value="0"/>
        <average id="engaged" value="0.00%"/>
        <average id="unique_engaged_events" value="0"/>
        <average id="unique_engaged" value="0.00%"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="sumviews" value="9"/>
        <total id="interactive_view_events" value="8"/>
        <total id="interactive_views" value="88.89%"/>
        <total id="interactive_time" value="22s"/>
        <total id="average_interactive_time" value="2.8s"/>
        <total id="sumclicks" value="2"/>
        <total id="interactive_clicks" value="7.69%"/>
        <total id="expanded_view_events" value="0"/>
        <total id="expanded_views" value="0.00%"/>
        <total id="expanded_time" value="0s"/>
        <total id="average_expanded_time" value="0s"/>
        <total id="engaged_events" value="0"/>
        <total id="engaged" value="0.00%"/>
        <total id="unique_engaged_events" value="0"/>
        <total id="unique_engaged" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Keywords

Description

Allows you to generate a campaign keywords report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/keywords

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • keyword
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/keywords?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/keywords" startdate="2010-10-30" stopdate="2010-10-30" type="keywords">
  <criteria>
    <param name="Name" value="Keywords Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by keyword.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered by keyword frequency as well as performance throughout the selected date range.  Keywords with the highest frequency are those that have been passed to the ad server most frequently out of all keywords while keywords with the highest performance are only the ones that were successfully targeted.</description>
  <content>
    <section id="keyword_frequency" name="Keyword Frequency Summary">
      <fields>
        <field id="keyword" name="Keywords" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="keyword" value="ad server"/>
          <column id="share" value="42.11%"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="12.50%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad serving software"/>
          <column id="share" value="42.11%"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="12.50%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad management"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad targeting"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="banner server"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="keyword" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="4"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.11%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="keyword" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="19"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.11%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="keyword_performance" name="Keyword Performance Summary">
      <fields>
        <field id="keyword" name="Keywords" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="keyword" value="ad server"/>
          <column id="share" value="42.11%"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="12.50%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad serving software"/>
          <column id="share" value="42.11%"/>
          <column id="sumviews" value="8"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="12.50%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad management"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="ad targeting"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="keyword" value="banner server"/>
          <column id="share" value="5.26%"/>
          <column id="sumviews" value="1"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="keyword" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="4"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.11%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="keyword" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="19"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.11%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Languages

Description

Allows you to generate a campaign languages report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/languages

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • l.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/languages?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/languages" startdate="2010-10-30" stopdate="2010-10-30" type="languages">
  <criteria>
    <param name="Name" value="Language Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by language.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different visitors based upon their primary language throughout the selected date range.</description>
  <content>
    <section id="languages" name="Language Summary">
      <fields>
        <field id="l.id" name="ID" format="none"/>
        <field id="l.name" name="Language" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="l.id" value="en"/>
          <column id="l.name" value="English"/>
          <column id="share" value="50.00%"/>
          <column id="sumviews" value="100"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="1.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="l.id" value="es"/>
          <column id="l.name" value="Spanish"/>
          <column id="share" value="50.00%"/>
          <column id="sumviews" value="100"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="1.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="l.id" value="n/a"/>
        <average id="l.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="100"/>
        <average id="sumclicks" value="1"/>
        <average id="clickratio" value="1.00%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="l.id" value="n/a"/>
        <total id="l.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="200"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="1.00%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Network

Description

Allows you to generate a campaign network report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/network

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
typeStringYesip Must be a String equal to one of the following values:
  • ip
  • org
  • sld
  • tld
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • ip: a,b,c, sumviews, sumclicks, clickratio, sumactions, actionratio
  • org: org, sumviews, sumclicks, clickratio, sumactions, actionratio
  • sld: sld, sumviews, sumclicks, clickratio, sumactions, actionratio
  • tld: tld, sumviews, sumclicks, clickratio, sumactions, actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/network?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&type=ip&format=xml


<report id="campaigns/network" startdate="2010-10-30" stopdate="2010-10-30" type="ip">
  <criteria>
    <param name="Name" value="Network :: IP Address Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by IP address.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different IP addresses throughout the selected date range.</description>
  <content>
    <section id="ip" name="Network :: IP Address Summary">
      <fields>
        <field id="a,b,c" name="IP Address" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="a,b,c" value="71.61.234.*"/>
          <column id="share" value="68.42%"/>
          <column id="sumviews" value="52"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="3.85%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="a,b,c" value="216.157.25.*"/>
          <column id="share" value="31.58%"/>
          <column id="sumviews" value="24"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="a,b,c" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="38"/>
        <average id="sumclicks" value="1"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="a,b,c" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Referrer

Description

Allows you to generate a campaign referrer report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/referrer

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • referrer
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/referrer?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/referrer" startdate="2010-10-30" stopdate="2010-10-30" type="referrer">
  <criteria>
    <param name="Name" value="Referrer URL Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by referrer.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different referrers throughout the selected date range.</description>
  <content>
    <section id="referrer" name="Referrer URL Summary">
      <fields>
        <field id="referrer" name="Referrer URL" format="hyperlink"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="referrer" value="http://renegadeinternet.com/"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="referrer" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="referrer" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

ROI

Description

Allows you to generate a campaign ROI report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/roi

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • name
  • revenue
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/roi?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/roi" startdate="2010-10-30" stopdate="2010-10-30" type="roi">
  <criteria>
    <param name="Name" value="ROI Summary"/>
    <param name="Campaign" value="Renegade Internet"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of revenue generated for your advertisers from purchases that were referred by you.  By looking at this report, you can quickly see how much revenue has been generated throughout the selected date range.</description>
  <content>
    <section id="roi" name="ROI Summary">
      <fields>
        <field id="name" name="Media Name" format="none"/>
        <field id="revenue" name="Revenue" format="currency"/>
      </fields>
      <data>
        <row>
          <column id="name" value="Renegade Internet 728x90"/>
          <column id="revenue" value="153.79"/>
        </row>
      </data>
      <averages>
        <average id="name" value="n/a"/>
        <average id="revenue" value="153.79"/>
      </averages>
      <totals>
        <total id="name" value="n/a"/>
        <total id="revenue" value="153.79"/>
      </totals>
    </section>
  </content>
</report>

Size

Description

Allows you to generate a campaign size report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/size

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosz.name Must be a String equal to one of the following values:
  • sz.id
  • sz.name
  • sz.width
  • sz.height
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/size?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/size" startdate="2010-10-30" stopdate="2010-10-30" type="size">
  <criteria>
    <param name="Name" value="Size Summary"/>
    <param name="Campaign" value="AdvertPro 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by media size.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered to different media sizes throughout the selected date range.</description>
  <content>
    <section id="size" name="Size Summary">
      <fields>
        <field id="sz.id" name="ID" format="number"/>
        <field id="sz.name" name="Size" format="none"/>
        <field id="sz.width" name="Width" format="number"/>
        <field id="sz.height" name="Height" format="number"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="sz.id" value="14"/>
          <column id="sz.name" value="Skyscraper"/>
          <column id="sz.width" value="120"/>
          <column id="sz.height" value="600"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="153"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="1.31%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="sz.id" value="n/a"/>
        <average id="sz.name" value="n/a"/>
        <average id="sz.width" value="n/a"/>
        <average id="sz.height" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="153"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.01%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="sz.id" value="n/a"/>
        <total id="sz.name" value="n/a"/>
        <total id="sz.width" value="n/a"/>
        <total id="sz.height" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="153"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.01%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Software

Description

Allows you to generate a campaign software report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/software

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
typeStringYescookies Must be a String equal to one of the following values:
  • cookies
  • device
  • javascript
  • os
  • browser
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNodate Must be a String equal to one of the following values:
  • cookies: date, enabled, enabledratio, disabled, disabledratio, total
  • javascript: date, enabled, enabledratio, disabled, disabledratio, unknown, unknownratio, total
  • os: o.id, o.name, sumviews, sumclicks, clickratio, sumactions, actionratio
  • browser: b.id, b.name, sumviews, sumclicks, clickratio, sumactions, actionratio
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/software?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&type=cookies&format=xml


<report id="campaigns/software" startdate="2010-10-30" stopdate="2010-10-30" type="cookies">
  <criteria>
    <param name="Name" value="Software :: Cookie Support Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows the percentage of visitors that have their browsers set to allow cookies.  By looking at this report, you can quickly see how many visitors have had cookies enabled or disabled throughout the selected date range.</description>
  <content>
    <section id="cookies" name="Software :: Cookie Support Summary">
      <fields>
        <field id="date" name="Date" format="date"/>
        <field id="enabled" name="Enabled Views" format="number"/>
        <field id="enabledratio" name="Enabled" format="percentage"/>
        <field id="disabled" name="Disabled Views" format="number"/>
        <field id="disabledratio" name="Disabled" format="percentage"/>
        <field id="total" name="Total Views" format="number"/>
      </fields>
      <data>
        <row>
          <column id="date" value="2010-10-30"/>
          <column id="enabled" value="100"/>
          <column id="enabledratio" value="100.00%"/>
          <column id="disabled" value="0"/>
          <column id="disabledratio" value="0.00%"/>
          <column id="total" value="100"/>
        </row>
      </data>
      <averages>
        <average id="date" value="n/a"/>
        <average id="enabled" value="100"/>
        <average id="enabledratio" value="100.00%"/>
        <average id="disabled" value="0"/>
        <average id="disabledratio" value="0.00%"/>
        <average id="total" value="100"/>
      </averages>
      <totals>
        <total id="date" value="n/a"/>
        <total id="enabled" value="100"/>
        <total id="enabledratio" value="100.00%"/>
        <total id="disabled" value="0"/>
        <total id="disabledratio" value="0.00%"/>
        <total id="total" value="100"/>
      </totals>
    </section>
  </content>
</report>

Video

Description

Allows you to generate an campaign video report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/video

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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • requests
  • sumviews
  • start_events
  • start
  • first_quartile_events
  • first_quartile
  • midpoint_events
  • midpoint
  • third_quartile_events
  • third_quartile
  • complete_events
  • complete
  • mute_events
  • mute
  • unmute_events
  • unmute
  • pause_events
  • pause
  • resume_events
  • resume
  • replay_events
  • replay
  • stop_events
  • stop
  • fullscreen_events
  • fullscreen
  • skip_events
  • skip
  • close_events
  • close
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/video?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/video" startdate="2010-10-30" stopdate="2010-10-30" type="video">
  <criteria>
    <param name="Name" value="Video Summary"/>
    <param name="campaign" value="ACME"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a breakdown of video engagement.  By looking at this report, you can quickly see how many videos were viewed and watched to completion throughout the selected date range.</description>
  <content>
    <section id="video" name="Video Summary">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media Name" format="none"/>
        <field id="requests" name="Requests" format="number"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="start_events" name="Start Events" format="number"/>
        <field id="start" name="Start" format="percentage"/>
        <field id="first_quartile_events" name="First Quartile Events" format="number"/>
        <field id="first_quartile" name="First Quartile" format="percentage"/>
        <field id="midpoint_events" name="Midpoint Events" format="number"/>
        <field id="midpoint" name="Midpoint" format="percentage"/>
        <field id="third_quartile_events" name="Third Quartile Events" format="number"/>
        <field id="third_quartile" name="Third Quartile" format="percentage"/>
        <field id="complete_events" name="Complete Events" format="number"/>
        <field id="complete" name="Complete" format="percentage"/>
        <field id="mute_events" name="Mute Events" format="number"/>
        <field id="mute" name="Mute" format="percentage"/>
        <field id="unmute_events" name="Unmute Events" format="number"/>
        <field id="unmute" name="Unmute" format="percentage"/>
        <field id="pause_events" name="Pause Events" format="number"/>
        <field id="pause" name="Pause" format="percentage"/>
        <field id="resume_events" name="Resume Events" format="number"/>
        <field id="resume" name="Resume" format="percentage"/>
        <field id="replay_events" name="Replay Events" format="number"/>
        <field id="replay" name="Replay" format="percentage"/>
        <field id="stop_events" name="Stop Events" format="number"/>
        <field id="stop" name="Stop" format="percentage"/>
        <field id="fullscreen_events" name="Fullscreen Events" format="number"/>
        <field id="fullscreen" name="Fullscreen" format="percentage"/>
        <field id="skip_events" name="Skip Events" format="number"/>
        <field id="skip" name="Skip" format="percentage"/>
        <field id="close_events" name="Close Events" format="number"/>
        <field id="close" name="Close" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="63"/>
          <column id="m.name" value="ACME / Pre-Roll Video"/>
          <column id="requests" value="8"/>
          <column id="sumviews" value="8"/>
          <column id="start_events" value="8"/>
          <column id="start" value="100.00%"/>
          <column id="first_quartile_events" value="7"/>
          <column id="first_quartile" value="87.50%"/>
          <column id="midpoint_events" value="6"/>
          <column id="midpoint" value="75.00%"/>
          <column id="third_quartile_events" value="5"/>
          <column id="third_quartile" value="62.50%"/>
          <column id="complete_events" value="5"/>
          <column id="complete" value="62.50%"/>
          <column id="mute_events" value="0"/>
          <column id="mute" value="0.00%"/>
          <column id="unmute_events" value="0"/>
          <column id="unmute" value="0.00%"/>
          <column id="pause_events" value="0"/>
          <column id="pause" value="0.00%"/>
          <column id="resume_events" value="0"/>
          <column id="resume" value="0.00%"/>
          <column id="replay_events" value="0"/>
          <column id="replay" value="0.00%"/>
          <column id="stop_events" value="0"/>
          <column id="stop" value="0.00%"/>
          <column id="fullscreen_events" value="0"/>
          <column id="fullscreen" value="0.00%"/>
          <column id="skip_events" value="0"/>
          <column id="skip" value="0.00%"/>
          <column id="close_events" value="0"/>
          <column id="close" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="requests" value="8"/>
        <average id="sumviews" value="8"/>
        <average id="start_events" value="8"/>
        <average id="start" value="100.00%"/>
        <average id="first_quartile_events" value="7"/>
        <average id="first_quartile" value="87.50%"/>
        <average id="midpoint_events" value="6"/>
        <average id="midpoint" value="75.00%"/>
        <average id="third_quartile_events" value="5"/>
        <average id="third_quartile" value="62.50%"/>
        <average id="complete_events" value="5"/>
        <average id="complete" value="62.50%"/>
        <average id="mute_events" value="0"/>
        <average id="mute" value="0.00%"/>
        <average id="unmute_events" value="0"/>
        <average id="unmute" value="0.00%"/>
        <average id="pause_events" value="0"/>
        <average id="pause" value="0.00%"/>
        <average id="resume_events" value="0"/>
        <average id="resume" value="0.00%"/>
        <average id="replay_events" value="0"/>
        <average id="replay" value="0.00%"/>
        <average id="stop_events" value="0"/>
        <average id="stop" value="0.00%"/>
        <average id="fullscreen_events" value="0"/>
        <average id="fullscreen" value="0.00%"/>
        <average id="skip_events" value="0"/>
        <average id="skip" value="0.00%"/>
        <average id="close_events" value="0"/>
        <average id="close" value="0.00%"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="requests" value="8"/>
        <total id="sumviews" value="8"/>
        <total id="start_events" value="8"/>
        <total id="start" value="100.00%"/>
        <total id="first_quartile_events" value="7"/>
        <total id="first_quartile" value="87.50%"/>
        <total id="midpoint_events" value="6"/>
        <total id="midpoint" value="75.00%"/>
        <total id="third_quartile_events" value="5"/>
        <total id="third_quartile" value="62.50%"/>
        <total id="complete_events" value="5"/>
        <total id="complete" value="62.50%"/>
        <total id="mute_events" value="0"/>
        <total id="mute" value="0.00%"/>
        <total id="unmute_events" value="0"/>
        <total id="unmute" value="0.00%"/>
        <total id="pause_events" value="0"/>
        <total id="pause" value="0.00%"/>
        <total id="resume_events" value="0"/>
        <total id="resume" value="0.00%"/>
        <total id="replay_events" value="0"/>
        <total id="replay" value="0.00%"/>
        <total id="stop_events" value="0"/>
        <total id="stop" value="0.00%"/>
        <total id="fullscreen_events" value="0"/>
        <total id="fullscreen" value="0.00%"/>
        <total id="skip_events" value="0"/>
        <total id="skip" value="0.00%"/>
        <total id="close_events" value="0"/>
        <total id="close" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Viewability

Description

Allows you to generate an campaign viewability report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/viewability

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2016-01-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2016-12-31 Must be a Date in yyyy-MM-dd format
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
orderByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • sumviews
  • displays
  • display_time
  • average_display_time
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/viewability?secret=(key)&startDate=2016-01-01&stopDate=2016-12-31&campaign=123&format=xml


<report id="campaigns/viewability" startdate="2016-01-01" stopdate="2016-12-31" type="viewability">
  <criteria>
    <param name="Name" value="Viewability Summary"/>
    <param name="Campaign" value="American Express 468x60"/>
    <param name="Start Date" value="January 1, 2016"/>
    <param name="Stop Date" value="December 31, 2016"/>
  </criteria>
  <description>This report provides various insights into the placement and viewability of creatives.  Viewable impressions are counted when 50% or more of the creative is viewable for at least 1 second. However, only 30% of the creative need be visible if the surface area (width x height) of the creative exceeds 242,500 pixels.  It should also be noted that viewability cannot be fully measured when creatives are loaded via IFRAME tags.</description>
  <content>
    <section id="viewability" name="Viewability Summary">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media Name" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="display_events" name="Viewable Impressions" format="number"/>
        <field id="displays" name="Viewable Rate" format="percentage"/>
        <field id="display_time" name="Viewable Time" format="interval"/>
        <field id="average_display_time" name="Average Viewable Time" format="interval"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="9"/>
          <column id="m.name" value="American Express 468x60"/>
          <column id="sumviews" value="9"/>
          <column id="display_events" value="1"/>
          <column id="displays" value="11.11%"/>
          <column id="display_time" value="48s"/>
          <column id="average_display_time" value="48s"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="sumviews" value="9"/>
        <average id="display_events" value="1"/>
        <average id="displays" value="11.11%"/>
        <average id="display_time" value="48s"/>
        <average id="average_display_time" value="48s"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="sumviews" value="9"/>
        <total id="display_events" value="1"/>
        <total id="displays" value="11.11%"/>
        <total id="display_time" value="48s"/>
        <total id="average_display_time" value="48s"/>
      </totals>
    </section>
  </content>
</report>

Weather

Description

Allows you to generate an campaign weather report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/weather

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2016-01-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2016-12-31 Must be a Date in yyyy-MM-dd format
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
orderByStringNoz.name Must be a String equal to one of the following values:
  • z.id
  • z.name
  • sumviews
  • displays
  • display_time
  • average_display_time
sortDirectionStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/weather?secret=(key)&startDate=2016-01-01&stopDate=2016-12-31&campaign=123&format=xml


<report id="campaigns/weather" startdate="2017-01-01" stopdate="2017-12-31" type="weather">
  <criteria>
    <param name="Name" value="Weather Summary"/>
    <param name="Campaign" value="American Express"/>
    <param name="Start Date" value="January 1, 2017"/>
    <param name="Stop Date" value="December 31, 2017"/>
  </criteria>
  <description>This report shows a breakdown of impressions, clicks, and actions organized by weather condition.  By looking at this report, you can quickly see how impressions, clicks, and actions were affected by different weather conditions throughout the selected date range.</description>
  <content>
    <section id="weather_condition" name="Weather Conditions">
      <fields>
        <field id="weather_condition" name="Weather Condition" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="weather_condition" value="Cloudy"/>
          <column id="share" value="71.43%"/>
          <column id="sumviews" value="15"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="weather_condition" value="Unknown"/>
          <column id="share" value="28.57%"/>
          <column id="sumviews" value="6"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="weather_condition" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="11"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.00%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="weather_condition" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="21"/>
        <total id="sumclicks" value="0"/>
        <total id="clickratio" value="0.00%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="weather_humidity" name="Humidity Ranges">
      <fields>
        <field id="humidity" name="Humidity Range" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="humidity" value="80-89%"/>
          <column id="share" value="71.43%"/>
          <column id="sumviews" value="15"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="humidity" value="Unknown"/>
          <column id="share" value="28.57%"/>
          <column id="sumviews" value="6"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="humidity" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="11"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.00%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="humidity" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="21"/>
        <total id="sumclicks" value="0"/>
        <total id="clickratio" value="0.00%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="weather_temperature" name="Temperature Ranges">
      <fields>
        <field id="temperature" name="Temperature Range" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="temperature" value="45-59°F"/>
          <column id="share" value="71.43%"/>
          <column id="sumviews" value="15"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="temperature" value="Unknown"/>
          <column id="share" value="28.57%"/>
          <column id="sumviews" value="6"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="temperature" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="11"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.00%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="temperature" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="21"/>
        <total id="sumclicks" value="0"/>
        <total id="clickratio" value="0.00%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>

Summary

Description

Allows you to generate a campaign summary report.

Module URI

Hyperlink /servlet/control/api/reports/campaigns/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
campaignCSV
Integer
Yes123 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing campaign(s).
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)
dimensionStringNo(none) Must be a String equal to one of the following values:
  • date
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
conversionsDatabooleanNotrue Must be a boolean value equal to either true or false
customDatabooleanNofalse Must be a boolean value equal to either true or false
dailyDatabooleanNotrue Must be a boolean value equal to either true or false
eventsDatabooleanNotrue Must be a boolean value equal to either true or false
geographyDatabooleanNofalse Must be a boolean value equal to either true or false
groupDatabooleanNotrue Must be a boolean value equal to either true or false
hourlyDatabooleanNotrue Must be a boolean value equal to either true or false
interactiveDatabooleanNofalse Must be a boolean value equal to either true or false
keywordsDatabooleanNofalse Must be a boolean value equal to either true or false
languagesDatabooleanNofalse Must be a boolean value equal to either true or false
mediaDatabooleanNotrue Must be a boolean value equal to either true or false
networkDatabooleanNofalse Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
referrerDatabooleanNofalse Must be a boolean value equal to either true or false
roiDatabooleanNofalse Must be a boolean value equal to either true or false
sizeDatabooleanNotrue Must be a boolean value equal to either true or false
softwareDatabooleanNofalse Must be a boolean value equal to either true or false
videoDatabooleanNotrue Must be a boolean value equal to either true or false
viewabilityDatabooleanNotrue Must be a boolean value equal to either true or false
weatherDatabooleanNotrue 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)
customOrdByStringNosumviews Must be a String equal to one of the following values:
  • data
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
conversionsOrdByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • conversions
  • converted_view_events
  • converted_views
  • converted_click_events
  • converted_clicks
conversionsSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
customSrtDirStringNoDESC 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
  • clickratio
  • sumactions
  • actionratio
dailySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
eventsCounterOrdByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • event_count
  • triggered_rate
eventsCounterSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
eventsExitOrdByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • event_count
  • triggered_rate
eventsExitSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
eventsVideoOrdByStringNoevent_name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • event_name
  • start_events
  • start
  • first_quartile_events
  • first_quartile
  • midpoint_events
  • midpoint
  • third_quartile_events
  • third_quartile
  • complete_events
  • complete
  • replay_events
  • replay
  • pause_events
  • pause
  • resume_events
  • resume
  • mute_events
  • mute
  • unmute_events
  • unmute
  • fullscreen_events
  • fullscreen
  • skip_events
  • skip
  • close_events
  • close
eventsVideoSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyContinentOrdByStringNosumviews Must be a String equal to one of the following values:
  • g.id
  • g.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyContinentSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyCountryOrdByStringNosumviews Must be a String equal to one of the following values:
  • g.id
  • g.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyCountrySrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyPostalOrdByStringNosumviews Must be a String equal to one of the following values:
  • c.id
  • c.name
  • s.postal
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyPostalSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyStateOrdByStringNosumviews Must be a String equal to one of the following values:
  • state
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyStateSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyStateCityOrdByStringNosumviews Must be a String equal to one of the following values:
  • c.id
  • c.name
  • s.state
  • s.city
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyStateCitySrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyDMAOrdByStringNosumviews Must be a String equal to one of the following values:
  • cc.name
  • g.id
  • g.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyDMASrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
geographyTimeZoneOrdByStringNosumviews Must be a String equal to one of the following values:
  • g.id
  • g.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
geographyTimeZoneSrtDirStringNoDESC 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
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
groupSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
hourlyOrdByStringNohour Must be a String equal to one of the following values:
  • hour
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
hourlySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
interactiveOrdByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • sumviews
  • interactive_views
  • interactive_view_events
  • interactive_time
  • average_interactive_time
  • sumclicks
  • interactive_clicks
  • expanded_views
  • expanded_view_events
  • expanded_time
  • average_expanded_time
  • engaged_events
  • engaged
  • unique_engaged_events
  • unique_engaged
interactiveSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
keywordsOrdByStringNosumviews Must be a String equal to one of the following values:
  • keyword
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
keywordsSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
languagesOrdByStringNosumviews Must be a String equal to one of the following values:
  • l.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
languagesSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
mediaOrdByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
mediaSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
networkIPOrdByStringNosumviews Must be a String equal to one of the following values:
  • a,b,c
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
networkIPSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
networkOrgOrdByStringNosumviews Must be a String equal to one of the following values:
  • org
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
networkOrgSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
networkSLDOrdByStringNosumviews Must be a String equal to one of the following values:
  • sld
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
networkSLDSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
networkTLDOrdByStringNosumviews Must be a String equal to one of the following values:
  • tld
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
networkTLDSrtDirStringNoDESC 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
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
publisherSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
referrerOrdByStringNosumviews Must be a String equal to one of the following values:
  • referrer
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
referrerSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
roiOrdByStringNodate Must be a String equal to one of the following values:
  • name
  • revenue
roiSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
sizeOrdByStringNosz.name Must be a String equal to one of the following values:
  • sz.id
  • sz.name
  • sz.width
  • sz.height
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
sizeSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
softwareBrowserOrdByStringNosumviews Must be a String equal to one of the following values:
  • b.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
softwareBrowserSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
softwareCookiesOrdByStringNodate Must be a String equal to one of the following values:
  • date
  • enabled
  • enabledratio
  • disabled
  • disabledratio
  • total
softwareCookiesSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC
softwareJSOrdByStringNodate Must be a String equal to one of the following values:
  • date
  • enabled
  • enabledratio
  • disabled
  • disabledratio
  • unknown
  • unknownratio
  • total
softwareJSSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
softwareOSOrdByStringNosumviews Must be a String equal to one of the following values:
  • o.name
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
softwareOSSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
videoOrdByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • requests
  • sumviews
  • start_events
  • start
  • first_quartile_events
  • first_quartile
  • midpoint_events
  • midpoint
  • third_quartile_events
  • third_quartile
  • complete_events
  • complete
  • mute_events
  • mute
  • unmute_events
  • unmute
  • pause_events
  • pause
  • resume_events
  • resume
  • replay_events
  • replay
  • stop_events
  • stop
  • fullscreen_events
  • fullscreen
  • skip_events
  • skip
  • close_events
  • close
videoSrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
viewabilityOrdByStringNom.name Must be a String equal to one of the following values:
  • m.id
  • m.name
  • sumviews
  • displays
  • display_time
  • average_display_time
viewabilitySrtDirStringNoASC Must be a String equal to one of the following values:
  • ASC
  • DESC
weatherOrdByStringNosumviews Must be a String equal to one of the following values:
  • weather_condition
  • temperature
  • humidity
  • sumviews
  • displays
  • display_time
  • average_display_time
weatherSrtDirStringNoDESC 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
  • share
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
zoneSrtDirStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/campaigns/summary?secret=(key)&startDate=2010-10-30&stopDate=2010-10-30&campaign=123&format=xml


<report id="campaigns/summary" startdate="2010-10-30" stopdate="2010-10-30" type="summary">
  <criteria>
    <param name="Name" value="Campaign Summary"/>
    <param name="Campaign" value="AdvertPRO 120x600"/>
    <param name="Start Date" value="October 30, 2010"/>
    <param name="Stop Date" value="October 30, 2010"/>
  </criteria>
  <description>This report shows a summary breakdown of impressions, clicks, and actions.  By looking at this report, you can quickly see how many impressions, clicks, and actions you have delivered throughout the selected date range.</description>
  <content>
    <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="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="date" value="2010-10-30"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="date" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="date" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </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="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="g.id" value="1"/>
          <column id="g.name" value="Default"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="g.id" value="n/a"/>
        <average id="g.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="g.id" value="n/a"/>
        <total id="g.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="hourly" name="Hourly Summary">
      <fields>
        <field id="hour" name="Hour" format="none"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="hour" value="12:00 - 12:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="01:00 - 01:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="02:00 - 02:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="03:00 - 03:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="04:00 - 04:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="05:00 - 05:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="06:00 - 06:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="07:00 - 07:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="08:00 - 08:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="09:00 - 09:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="10:00 - 10:59 AM"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="11:00 - 11:59 AM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="12:00 - 12:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="01:00 - 01:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="02:00 - 02:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="03:00 - 03:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="04:00 - 04:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="05:00 - 05:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="06:00 - 06:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="07:00 - 07:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="08:00 - 08:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="09:00 - 09:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="10:00 - 10:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="hour" value="11:00 - 11:59 PM"/>
          <column id="sumviews" value="0"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="hour" value="n/a"/>
        <average id="sumviews" value="3"/>
        <average id="sumclicks" value="0"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="hour" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="media" name="Media Summary">
      <fields>
        <field id="m.id" name="ID" format="number"/>
        <field id="m.name" name="Media" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="m.id" value="6"/>
          <column id="m.name" value="AdvertPRO / 120x600 / Geographical Targeting"/>
          <column id="share" value="32.89%"/>
          <column id="sumviews" value="25"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="4.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="m.id" value="7"/>
          <column id="m.name" value="AdvertPRO / 120x600 / Real-time Reporting"/>
          <column id="share" value="32.89%"/>
          <column id="sumviews" value="25"/>
          <column id="sumclicks" value="0"/>
          <column id="clickratio" value="0.00%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
        <row>
          <column id="m.id" value="8"/>
          <column id="m.name" value="AdvertPRO / 120x600 / Rich Media Creativity"/>
          <column id="share" value="34.21%"/>
          <column id="sumviews" value="26"/>
          <column id="sumclicks" value="1"/>
          <column id="clickratio" value="3.85%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="m.id" value="n/a"/>
        <average id="m.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="25"/>
        <average id="sumclicks" value="1"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="m.id" value="n/a"/>
        <total id="m.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <section id="publisher" name="Publisher Summary">
      <fields>
        <field id="p.id" name="ID" format="number"/>
        <field id="p.name" name="Publisher" format="none"/>
        <field id="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="p.id" value="1"/>
          <column id="p.name" value="Renegade Internet"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="p.id" value="n/a"/>
        <average id="p.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="p.id" value="n/a"/>
        <total id="p.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
    <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="share" name="Share" format="percentage"/>
        <field id="sumviews" name="Views" format="number"/>
        <field id="sumclicks" name="Clicks" format="number"/>
        <field id="clickratio" name="CTR" format="percentage"/>
        <field id="sumactions" name="Actions" format="number"/>
        <field id="actionratio" name="ACR" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="z.id" value="7"/>
          <column id="z.name" value="Articles Skyscraper / 120x600"/>
          <column id="share" value="100.00%"/>
          <column id="sumviews" value="76"/>
          <column id="sumclicks" value="2"/>
          <column id="clickratio" value="2.63%"/>
          <column id="sumactions" value="0"/>
          <column id="actionratio" value="0.00%"/>
        </row>
      </data>
      <averages>
        <average id="z.id" value="n/a"/>
        <average id="z.name" value="n/a"/>
        <average id="share" value="n/a"/>
        <average id="sumviews" value="76"/>
        <average id="sumclicks" value="2"/>
        <average id="clickratio" value="0.03%"/>
        <average id="sumactions" value="0"/>
        <average id="actionratio" value="0.00%"/>
      </averages>
      <totals>
        <total id="z.id" value="n/a"/>
        <total id="z.name" value="n/a"/>
        <total id="share" value="n/a"/>
        <total id="sumviews" value="76"/>
        <total id="sumclicks" value="2"/>
        <total id="clickratio" value="0.03%"/>
        <total id="sumactions" value="0"/>
        <total id="actionratio" value="0.00%"/>
      </totals>
    </section>
  </content>
</report>