Version 5.0
AdvertServe User Manual :: v5.0

Reports :: Executive API Module

Modules

Forensiq

Description

Allows you to generate a Forensiq traffic quality report. This report may not be available to all users. It requires an account with Forensiq to be activated.

Module URI

Hyperlink /servlet/control/api/reports/executive/forensiq

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
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
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
scoreIntegerNoconfig Must be an Integer between 0 and 100. Defaults to the Score Threshold in the Forensiq settings. Scores in the 0-64 range are considered non-suspicious, while 65-79 is suspicious and 80-100 is high risk.
rangeStringNoabove Must be a String equal to one of the following values:
  • above
  • below
thresholdIntegerNo10 Must be an Integer between 0 and 100. Say, for example, that you set score to a value of 65 and threshold to 10. This will result in a report containing only traffic sources with more than 10% of their requests having a score of 65 or higher.
requestsIntegerNo0 Must be an Integer greater than or equal to zero.
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
groupByStringNourl Must be a String equal to one of the following values, which correspond to the reporting parameter names passed to the Forensiq pre-bid API:
  • url
  • seller
  • sub
  • cmp
groupBy2StringNo(None) Must be a String equal to one of the following values, which correspond to the reporting parameter names passed to the Forensiq pre-bid API:
  • url
  • seller
  • sub
  • cmp
groupBy3StringNo(None) Must be a String equal to one of the following values, which correspond to the reporting parameter names passed to the Forensiq pre-bid API:
  • url
  • seller
  • sub
  • cmp
orderByStringNorequests Must be a String equal to one of the following values:
  • url
  • seller
  • sub
  • cmp
  • total_requests
  • requests
  • risk
sortDirectionStringNoDESC Must be a String equal to one of the following values:
  • ASC
  • DESC

XML Response

Hyperlink /servlet/control/api/reports/executive/forensiq?secret=(key)&score=65&threshold=3&groupBy=url&format=xml


<report id="executive/forensiq" startdate="2016-12-12" stopdate="2016-12-15" type="forensiq">
  <criteria>
    <param name="Name" value="Forensiq Traffic Quality"/>
    <param name="Start Date" value="December 12, 2016"/>
    <param name="Stop Date" value="December 15, 2016"/>
    <param name="Good Score" value="0 - 64"/>
    <param name="Bad Score" value="65 - 100"/>
    <param name="Threshold" value="3%"/>
  </criteria>
  <description>This report shows the percentage of traffic that is above or below the acceptable score threshold which allows you to quickly identify good and bad traffic sources.</description>
  <content>
    <section id="postal" name="Forensiq Traffic Quality">
      <fields>
        <field id="url" name="Referrer" format="none"/>
        <field id="total_requests" name="Total Requests" format="number"/>
        <field id="requests" name="Bad Requests" format="number"/>
        <field id="risk" name="Risk" format="percentage"/>
      </fields>
      <data>
        <row>
          <column id="url" value="http://www.example.com/"/>
          <column id="total_requests" value="19"/>
          <column id="requests" value="1"/>
          <column id="risk" value="5.26%"/>
        </row>
      </data>
      <averages>
        <average id="url" value="n/a"/>
        <average id="total_requests" value="19"/>
        <average id="requests" value="1"/>
        <average id="risk" value="5.26%"/>
      </averages>
      <totals>
        <total id="url" value="n/a"/>
        <total id="total_requests" value="19"/>
        <total id="requests" value="1"/>
        <total id="risk" value="5.26%"/>
      </totals>
    </section>
  </content>
</report>

Summary

Description

Allows you to generate an executive summary report.

Module URI

Hyperlink /servlet/control/api/reports/executive/summary

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
startDateDateYes2010-10-01 Must be a Date in yyyy-MM-dd format
stopDateDateYes2010-10-31 Must be a Date in yyyy-MM-dd format
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
formatStringNoxml Must be a String equal to one of the following values:
  • csv
  • excel
  • html
  • json
  • pdf
  • text
  • xml
definitionsbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
advertiserDatabooleanNotrue Must be a boolean value equal to either true or false
campaignDatabooleanNotrue Must be a boolean value equal to either true or false
mediaDatabooleanNotrue Must be a boolean value equal to either true or false
publisherDatabooleanNotrue Must be a boolean value equal to either true or false
zoneDatabooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Default ValueValidation Rules (If Applicable)
orderByStringNosumviews Must be a String equal to one of the following values:
  • pid
  • publisher_name
  • zid
  • zone_name
  • aid
  • advertiser_name
  • cid
  • campaign_name
  • mid
  • media_name
  • date
  • 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/executive/summary?secret=(key)&startDate=2015-06-01&stopDate=2015-06-03&zoneData=true&mediaData=true&format=xml


<report id="executive/summary" startdate="2015-06-01" stopdate="2015-06-03" type="summary">
  <criteria>
    <param name="Name" value="Executive Summary"/>
    <param name="Start Date" value="June 1, 2015"/>
    <param name="Stop Date" value="June 3, 2015"/>
  </criteria>
  <description>This report shows a consolidated view of impressions, clicks, and actions grouped by the specified criteria.  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="summary" 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="2015-06-01"/>
          <column id="sumviews" value="63"/>
          <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="date" value="2015-06-02"/>
          <column id="sumviews" value="99"/>
          <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="date" value="2015-06-03"/>
          <column id="sumviews" value="133"/>
          <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="date" value="n/a"/>
        <average id="sumviews" value="98"/>
        <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="date" value="n/a"/>
        <total id="sumviews" value="295"/>
        <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="summary_breakout_1-2" name="Banners : AdvertPro 468x60">
      <fields>
        <field id="zid" name="Zone ID#" format="number"/>
        <field id="zone_name" name="Zone" format="none"/>
        <field id="mid" name="Media ID#" format="number"/>
        <field id="media_name" name="Media" format="none"/>
        <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="zid" value="1"/>
          <column id="zone_name" value="Banners"/>
          <column id="mid" value="2"/>
          <column id="media_name" value="AdvertPro 468x60"/>
          <column id="date" value="2015-06-01"/>
          <column id="sumviews" value="63"/>
          <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="zid" value="1"/>
          <column id="zone_name" value="Banners"/>
          <column id="mid" value="2"/>
          <column id="media_name" value="AdvertPro 468x60"/>
          <column id="date" value="2015-06-02"/>
          <column id="sumviews" value="99"/>
          <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="zid" value="1"/>
          <column id="zone_name" value="Banners"/>
          <column id="mid" value="2"/>
          <column id="media_name" value="AdvertPro 468x60"/>
          <column id="date" value="2015-06-03"/>
          <column id="sumviews" value="133"/>
          <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="zid" value="n/a"/>
        <average id="zone_name" value="n/a"/>
        <average id="mid" value="n/a"/>
        <average id="media_name" value="n/a"/>
        <average id="date" value="n/a"/>
        <average id="sumviews" value="98"/>
        <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="zid" value="n/a"/>
        <total id="zone_name" value="n/a"/>
        <total id="mid" value="n/a"/>
        <total id="media_name" value="n/a"/>
        <total id="date" value="n/a"/>
        <total id="sumviews" value="295"/>
        <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>