Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc SDKs and APIs 7.13
  4. SDK Specification
  5. Alert tracking API
  6. Summary report

Summary report

Retrieves summary tracking data for a given alert.
If dependents are enabled, the summary report includes consolidated information for sponsors and dependents.
For more information, see the SDK envelope request.
The payload type is 
ALERT-TRACKING-SUMMARY.
The payload content should be in the following format: 
<alerts>
<alert withDistributionLists="true|false" withDevices="true|false" withHierarchy="true|false">alertId</alert>
</alerts>
<INFOCASTING> Tags
Tag
Mandatory
Description
<alerts>
Yes
Root node of the payload content.
<alert>
Yes
Specifies the alert ID for the report. Attributes:
withDistributionLists—optional, true or false. When true, distribution lists are included in the response.
withDevices—optional, true or false. When true, devices that were published to are included in the response.
withHierarchy—optional, true or false. When true, hierarchies that were published to are included in the response.
The SDK response will be: 
<AtHocSdkResponse>
<payload type="ALERT-TRACKING-SUMMARY" trackId="">
<ok>
<systemDate>yyyy-mm-ddThh:mm:ss.msZ</systemDate>
<responsePayload>
<report>
<alert id="alertId" name="">
<ack>1</ack>
<noResponse>0</noResponse>
<recv>1</recv>
<sent>1</sent>
<targeted>1</targeted>
<responses>
<response index="0">1</response>
<response index="1">0</response>
</responses>
<!-- If withDistributionLists="true", the distributionLists node is included in the response -->

<distributionLists>
<distributionList id="list ID" name="list name">
<ack>1</ack>
<noResponse>0</noResponse>
<recv>1</recv>
<sent>1</sent>
<targeted>1</targeted>
<responses>
<response index="0">1</response>
<response index="1">0</response>
</responses>
</distributionList>
. . .
</distributionLists>
<!-- if withDevices="true", the devices node is included in the response -->

<devices>
<device name="device name" id="device id">
<ack>1</ack>
<noResponse>0</noResponse>
<recv>1</recv>
<sent>1</sent>
<targeted>1</targeted>
<responses>
<response index="0">1</response>
<response index="1">0</response>
</responses>
</device>
. . .
</devices>
<!-- if withHierarchy="true", the hierarchies node is included in the response -- >

<hierarchies>
<hierarchy id="123456789" name="hierarchy_name">
<ack>1</ack>
<noResponse>1</noResponse>
<recv>2</recv>
<sent>2</sent>
<targeted>2</targeted>
<responses />
</hierarchy>
. . .
</hierarchies>
</alert>
. . .
</report>
</responsePayload>
<warnings />
</ok>
</payload>
</AtHocSdkResponse>