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

Detailed report by users and devices

Retrieve detailed tracking data for a given alert, broken down by users and devices. See SDK envelope request for more information.
If dependents are enabled, the detailed report includes information for sponsors and dependents.
The payload type is 
INFOCASTING
.
The payload content should be in the following format: 
<infocasting type="ALERT-TRACKING-DETAILS" id="1234567" auid="1111111-1111-1111-1111-111111111111">
<startRowIndex>1</startRowIndex>
</infocasting>
<INFOCASTING> tags
Tag
Mandatory
Description
<infocasting>
Yes
Root node of the payload content. Attributes: either id or auid is required.
  • type
    : (Required) The type of Alert Tracking. Must be ALERT-TRACKING-DETAILS.
  • id
    : The alert Id. Either id or auid is required. If id is present, auid is ignored.
  • auid
    : The system-generated value.
<startRowIndex>
No
Default: 1 (the report will start with the first record). When the report contains more than 1000 records, it is returned in pages of 1000 records. To request the next page of records, use <endRowIndex> from the response, increment by 1, and use that for <startRowIndex>. RowIndex is automatically generated by system. It is not contiguous.
You keep calling next page until the response contains 0 tracking events (<recordCount> node will contain value 0).
The SDK response will be: 
<report>
<endRowIndex>12345</endRowIndex>
<recordCount>123</recordCount>
<events>
<event type="Sent" userid="1234567" username="name" displayName="display name" 
deviceName="Desktop Popup" address="device address" timestamp="4/27/2017 
12:00:00 AM" messageText="" rowIndex="12345" />
<event type="Sent" userid="8912345" username="name" displayName="display name" 
deviceName="Desktop Popup" address="device address" timestamp="4/27/2010 
12:00:00 AM" messageText="" rowIndex="12349" />
.
.
.
</events>
</report>
Notes
  • username 
    is same as 
    mid
    .
  • rowIndex 
    is system-generated record number. It is not contiguous for same alert.
  • Timestamp 
    is UTC time.
  • endRowIndex 
    is the Max row index in 
    response
    .
  • recordCount
     is the total record number for the selected alert, regardless of how many are returned in the current response.