Getting the Tracker Settings

Obtains the current trackdata definition for a document. Returns an error if the trackdata function is not activated on this document.

Request

GET <webiURL>/documents/{documentId}/tracker

Where:

  • {documentId}: the identifier of the Web Intelligence document retrieved from the list of documents
Response

Response type: application/xml or application/json

Response body: definition of the trackdata information, described as follows:

  • The mode attribute of <tracker> is the mode of Track Data changes:
    • Auto: display changes are based on comparison with last data refresh
    • Manual: display changes are based on comparison with data refresh from user reference
  • The threshold attribute specifies the display changes threshold in percent for numeric data. The attribute type is double.

Example

GET <webiURL>/documents/8022/tracker

<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00"> 
    <added active="true"> 
        <background/> 
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000aa"/> 
    </added> 
    <changed active="true">  
        <background rgb="#aabbcc"/>  
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000bb"/>   
    </changed> 
    <removed active="true">  
        <background/> 
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000cc"/>   
    </removed>  
    <increasing threshold="5.0" applyThreshold="false" active="true"> 
        <background rgb="#33cc33"/>  
        <style italic="false" bold="true" strikethrough="false" underline="false"/> 
    </increasing>   
    <decreasing threshold="8.0" applyThreshold="true" active="false"> 
        <background rgb="#33cc33"/> 
        <style italic="true" bold="false" strikethrough="true" underline="true"/>
    </decreasing>
</tracker>