Get Report Meta Info Operation

The getReportMetaInfo operation retrieves the report column metadata for use together with the results of a getReport call using the same parameters. When the target report is a summary report, an extra column LLDetailTokenRef is added to columnInfo to indicate that it is a summary report.

Note: Only displayed columns in a custom report will be returned, not all columns.

Get Report Meta Info Request Parameter

The getReportMetaInfo operation request parameters are:

Parameter Description Values Required Type
authToken

Token string returned from the authentication service or the “username/password”.

  Yes String
applianceIP The Appliance from which you retrieve the metadata.

If the value is blank, it retrieves the Appliance IP address from the local Appliance.

This parameter is applicable for Management Station Appliances only.

IP address of a managed Appliance or All for retrieving an aggregated report from all managed Appliances. To specify an IP address, use the standard IP address format. For example:

10.1.2.3

Yes String
reportType Type or report to run.
  • 1 = Real Time report
  • 2 = Summary report
  • 3 = Custom report
Yes Number
reportName Name of a report, specified on the Appliance(s) that the user in authToken can access and run. If the reportType is 1 or 2, then the reportName must specify the report template name, and not the custom report name. You can get the reportName value after running the getTemplateReportList operation and get the reportName in the result by using the reportType.

if given the reportType is 3, then the reportName must be the report name created and saved by the user, or saved indexReport.

Yes String
sourceDeviceName Name of the log source to include in the report. One of:

Log source name

Log source IP address

Device Group name

An “All xxxx” devices name

No String

SOAP request example for reportType=1 or 2: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="ReportService">
   <soapenv:Header/>
   <soapenv:Body>
      <rep:getReportMetaInfo>
         <!--Optional:-->
         <rep:authToken>admin/admin123</rep:authToken>
         <!--Optional:-->
         <rep:applianceIP></rep:applianceIP>
         <rep:reportType>1</rep:reportType>
         <!--Optional:-->
         <rep:reportName>userAccess</rep:reportName>
         <!--Optional:-->
         <rep:sourceDeviceName>10.114.81.43</rep:sourceDeviceName>
      </rep:getReportMetaInfo>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response example for reportType=1 or 2: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getReportMetaInfoResponse xmlns:ns="ReportService">
         <ns:return xsi:type="ax225:ReportMetaInfo" xmlns:ax225="http://report.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax225:columnCount>19</ax225:columnCount>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>device</ax225:columnType>
               <ax225:displayName>Source Device</ax225:displayName>
               <ax225:internalName>deviceName</ax225:internalName>
               <ax225:shortDisplayName>Source Device</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>User</ax225:displayName>
               <ax225:internalName>user</ax225:internalName>
               <ax225:shortDisplayName>User</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Event ID</ax225:displayName>
               <ax225:internalName>eventId</ax225:internalName>
               <ax225:shortDisplayName>Event ID</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>ip_address</ax225:columnType>
               <ax225:displayName>Source IP</ax225:displayName>
               <ax225:internalName>clientIp</ax225:internalName>
               <ax225:shortDisplayName>Source IP</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Source Domain</ax225:displayName>
               <ax225:internalName>authDomain</ax225:internalName>
               <ax225:shortDisplayName>Source Domain</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Target User</ax225:displayName>
               <ax225:internalName>targetUser</ax225:internalName>
               <ax225:shortDisplayName>Target User</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>ip_address</ax225:columnType>
               <ax225:displayName>Target IP</ax225:displayName>
               <ax225:internalName>targetIp</ax225:internalName>
               <ax225:shortDisplayName>Target IP</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Target Domain</ax225:displayName>
               <ax225:internalName>targetDomain</ax225:internalName>
               <ax225:shortDisplayName>Target Domain</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Group</ax225:displayName>
               <ax225:internalName>userGroup</ax225:internalName>
               <ax225:shortDisplayName>Group</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Action</ax225:displayName>
               <ax225:internalName>userAction</ax225:internalName>
               <ax225:shortDisplayName>Action</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Status</ax225:displayName>
               <ax225:internalName>status</ax225:internalName>
               <ax225:shortDisplayName>Status</ax225:shortDisplayName>
            </ax225:colu

SOAP request example for reportType=3 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="ReportService">
   <soapenv:Header/>
   <soapenv:Body>
      <rep:getReportMetaInfo>
         <!--Optional:-->
         <rep:authToken>admin/admin123</rep:authToken>
         <!--Optional:-->
         <rep:applianceIP></rep:applianceIP>
         <rep:reportType>3</rep:reportType>
         <!--Optional:-->
         <rep:reportName>test1</rep:reportName>
         <!--Optional:-->
         <rep:sourceDeviceName>10.114.81.43</rep:sourceDeviceName>
      </rep:getReportMetaInfo>
   </soapenv:Body>
</soapenv:Envelope>

SOAP response example for reportType=3: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getReportMetaInfoResponse xmlns:ns="ReportService">
         <ns:return xsi:type="ax225:ReportMetaInfo" xmlns:ax225="http://report.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax225:columnCount>6</ax225:columnCount>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>device</ax225:columnType>
               <ax225:displayName>Source Device</ax225:displayName>
               <ax225:internalName>deviceName</ax225:internalName>
               <ax225:shortDisplayName>Source Device</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>User</ax225:displayName>
               <ax225:internalName>user</ax225:internalName>
               <ax225:shortDisplayName>User</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Action</ax225:displayName>
               <ax225:internalName>userAction</ax225:internalName>
               <ax225:shortDisplayName>Action</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Status</ax225:displayName>
               <ax225:internalName>status</ax225:internalName>
               <ax225:shortDisplayName>Status</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>counter</ax225:columnType>
               <ax225:displayName>Count</ax225:displayName>
               <ax225:internalName>count</ax225:internalName>
               <ax225:shortDisplayName>Count</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>LLDetailTokenRefType</ax225:columnType>
               <ax225:displayName>Detail Reference Token</ax225:displayName>
               <ax225:internalName>LLDetailTokenRef</ax225:internalName>
               <ax225:shortDisplayName>LLDetailTokenRef</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:errorCause>0</ax225:errorCause>
            <ax225:errorCode>0</ax225:errorCode>
         </ns:return>
      </ns:getReportMetaInfoResponse>
   </soapenv:Body>
</soapenv:Envelope>

Get Report Meta Info Response Attributes

The getReportMetaInfo response attributes are:

Attribute Description Type
errorCode Error code for the request number Number
errorCause Error cause code of the error Number
columnCount Number of columns returned in the report Number
columnInfo An array of reportColumnInfo (complex type). reportColumnInfo is a structure containing:

displayName (string)

shortDisplayName (string)

internalName (string)

columnType (string)

Array