Inspect the Query Response

The following abbreviated success response displays two individual segments and the segment aggregate. 
<reports>
   <report campaignId="7" start="2009-07-01" end="2009-08-02" resolution="day" type="visitor" segment="Segment 1" segmentId="0">
      <sample start="2009-08-01T00:00" duration="day">
         <recipe name="Experience A">
            <step name="Entry">476.0</step>
            <step name="Visits">370.0</steps>
            <step name="Display mboxes">476.0</step>
            <step name="Time on Site">1117.0</step>
            <step name="Page Count">1117.0</step>
            <step name="Score">1100.0</step>
            <step name="Global Mbox">1100.0</step>
            <step name="Clicked Article">255.0</step>
            <amount>121.13</amount>
            <engagementMetrics>
               <engagement stepName="Page Count" count="190" total="558.00000"sumOfSquares="4382.00000"/>
               <engagement stepName="Time on Site" count="211" total="44773.42500"sumOfSquares="43287221.65236"/>
               <engagement stepName="Score" count="207" total="117.00000"sumOfSquares="843.00000"/>
            </engagementMetrics>
         </recipe>
      </sample>
   </report>
   <report campaignId="7" start="2007-08-01" end="2007-08-02" resolution="day" type="visitor" segment="Segment 2" segmentId="1">
      .
      .
      .
   </report>
   <report campaignId="7" start="2007-08-01" end="2007-08-02" resolution="day" type="visitor">
      .
      .
      .
   </report>
</reports>
Tag Description
reports Contains all reports generated through a single Performance Report API request.
report Contains one report. The report tag supports the following attributes: campaignId: See the campaignId parameter in Include Parameters to Filter the Query. start: See the start parameter in Include Parameters to Filter the Query. end: See the end parameter in Include Parameters to Filter the Query. resolution: See the resolution parameter in Include Parameters to Filter the Query. type: See the type parameter in Include Parameters to Filter the Query. segment: The name of the segment used to generate this report. This attribute is omitted when generating an aggregate report of all segments. segmentId: The ID of the segment used to generate this report. T&T omits this attribute when generating an aggregate report of all segments.
sample Contains data for a single report interval. If there are no visitors in a given time interval (for example, day 2, or hour 5) the XML output omits that node. The sample tag supports the following attributes: start: The start date/time of the sample. duration: The duration of the sample, as defined by the resolution query parameter.
recipe Contains the recipe. The recipe attribute supports the following attribute: name: The recipe name.
step Contains the data (visitors, visits, or impressions) from a single success metric (display mboxes, eonversion, etc.) associated with this recipe. The step tag supports the following attribute: name: The success metric name.
amount Contains the revenue associated with this recipe.
engagementMetrics Contains the engagement metrics.
engagement The engagementMetrics tag supports the following attributes: stepName: The success metric name. count: The number of times this success metric has been viewed. total: The calculated value of the success metric. sumOfSquares: Contains the "Sum of Squares" value, which is useful for extreme order calculation.

The recipe named "Campaign" in each sample shows a summary for that sample.

A failed query response uses the following XML structure: 
<error>
   <message>Invalid email or password supplied. Email: my_email@abc.com</message>
   <code>401</code>
</error>
Tag Description
message A description of the error. For example: 
Invalid email or password supplied. Email: john@acme.com.
code The error code. For example: 401.

Comments (0)

Must be logged in to comment. or register now to comment!