{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"General","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"XPLG exposes a URL based API to the users. The API exposes a set of HTTP/S calls that can be used to retrieve information from XPLG.","type":"text"},{"type":"hardBreak"},{"text":"The article describes the syntax calls with the available parameters.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Background","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"XPLG’s API provides multiple calls to the system to get data, export dashboard, query the configuration and more.","type":"text"},{"type":"hardBreak"},{"text":"The call are done via URL over HTTP/S.","type":"text"},{"type":"hardBreak"},{"text":"In case security is activated in XPLG (login is required) then using the URL based API will require passing user's credentials in order to login into the system prior to executing the API command.","type":"text"},{"type":"hardBreak"},{"text":"It is required to pass the username and password in the URL to XPLG in order to get the command executed.","type":"text"}]},{"type":"paragraph","content":[{"text":"Add to each link that is detailed below at the end: ","type":"text"},{"type":"hardBreak"},{"text":"&autoLogin=true&username=[USER_NAME]&password=[PASSWORD]","type":"text"}]},{"type":"paragraph","content":[{"text":"[USER_NAME] = the user name which the API will use to login ","type":"text"},{"type":"hardBreak"},{"text":"[PASSWORD] = the password of the user name","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Endpoints","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"URL that returns events from XPLG Search in XML/CSV format","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-Events"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Runs a search query on a specified time frame and returns results in CSV or XML format","type":"text"}]},{"type":"paragraph","content":[{"text":"URL that returns a Dashboards latest result in PDF format","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-Dashboard"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Returns a dashboard from XPLG in PDF","type":"text"}]},{"type":"paragraph","content":[{"text":"URL to open Search console on an executed search query","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-Search"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Opens the XPLG search console on a search result page","type":"text"}]},{"type":"paragraph","content":[{"text":"URL that returns Collected Data Information","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-DataInfo"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Returns information about the data that is collected by the system in JSON format","type":"text"}]},{"type":"paragraph","content":[{"text":"URL that returns the Folders and Logs information","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-FoldersAndLogsInfo"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Returns the existing Folders and Logs structure from XPLG in JSON format","type":"text"}]},{"type":"paragraph","content":[{"text":"URL that returns a specific log's information","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-LogInfo"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Returns information about specific log in XPLG in JSON format","type":"text"}]},{"type":"paragraph","content":[{"text":"URL that returns multiple log's information","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#XPLGAPI-LogsDetailedInfo"}}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Returns information about multiple logs in XPLG in JSON format","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-Events"}},"macroMetadata":{"macroId":{"value":"45ffdada8fca5c0fe3f7065f98160761"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"1d856a6c-6629-4e74-91b5-f9321d6e7987"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns events from XPLG Search in XML/CSV format","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://[MACHINE_NAME]:[XPLG_PORT]/logeye/view/api/widgetAPI.jsp?widgetId=searchAPI&searchQuery=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]},{"text":"&fixedInterval=","type":"text"},{"text":"[see item 3]","type":"text","marks":[{"type":"strong"}]},{"text":"&startTimeFullStr=","type":"text"},{"text":"[see item 4]","type":"text","marks":[{"type":"strong"}]},{"text":"&endTimeFullStr=","type":"text"},{"text":"[see item 4]","type":"text","marks":[{"type":"strong"}]},{"text":"&maxNumOfRecords=","type":"text"},{"text":"[see item 5]","type":"text","marks":[{"type":"strong"}]},{"text":"&resultFormat=","type":"text"},{"text":"[see item 6]","type":"text","marks":[{"type":"strong"}]},{"text":"&paginate=","type":"text"},{"text":"[see item 7]","type":"text","marks":[{"type":"strong"}]},{"text":"&token=","type":"text"},{"text":"[see item 7.a]","type":"text","marks":[{"type":"strong"}]},{"text":"&maxRecordsPerPage=","type":"text"},{"text":"[see item 8]","type":"text","marks":[{"type":"strong"}]},{"text":"&timeout=","type":"text"},{"text":"[see item 9]","type":"text","marks":[{"type":"strong"}]},{"text":"&abortOn=","type":"text"},{"text":"[see item 10]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchQuery=a query as used in XpoSearch console","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixedInterval=optional values are: last15Minutes, last30Minutes, last60Minutes, last3Hours, last12Hours, last24Hours, last7Days, last14Days, last1Months, last6Months, currentDay, previousDay, currentWeek, previousWeek, allData","type":"text"},{"type":"hardBreak"},{"text":"IMPORTANT","type":"text","marks":[{"type":"strong"}]},{"text":": when using fixedInterval only values from the above list can be provided as is. Optional; if fixedInterval is used then startTimeFullStr and endTimeFullStr should not be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"startTimeFullStr=the start time full string, formatted according to the XPLG system format; default format is MM/dd/yyyy HH:mm:ss","type":"text"},{"type":"hardBreak"},{"text":"endTimeFullStr=the end time full string, formatted according to the XPLG system format; default format is MM/dd/yyyy HH:mm:ss","type":"text"},{"type":"hardBreak"},{"text":"Optional; used only if fixedInterval is missing; if used, both values are mandatory.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maxNumOfRecords=the maximal number of records to return in the result; if missing, the default value is taken from the widgets.searchAPI.maxNumOfRecords XPLG system property (default is 100 but may be modified)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"resultFormat=the format in which the result will be returned. Optional values xml/csv (case sensitive)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"paginate=activate pagination; optional values true/false. If pagination is set to true, a unique token will be generated per execution (unless the API command will specify an existing token to access next pages of an existing execution as detailed below at 7.a).","type":"text"},{"type":"hardBreak"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"token=UNIQUE_TOKEN_FROM_FIRST_EXECUTION - returned and may be used only if pagination is set to true, and only after an API command execution which is not already using an existing unique token. ","type":"text"},{"type":"hardBreak"},{"text":"If token is added to the URL, each execution of the URL returns the next page of that execution result (see result example below of pagination = true).","type":"text"},{"type":"hardBreak"},{"text":"In order to access the next pages of that execution result, it is required to add to the URL the parameter:","type":"text"},{"type":"hardBreak"},{"text":"&token=UNIQUE_TOKEN_FROM_FIRST_EXECUTION - any additional execution using the unique token will return the next page of results (there is no paging backwards, only forward).","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maxRecordsPerPage=the maximal number of results per page; If missing, the default value is 100 records per page.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timeout=the maximum time(milliseconds) given for a query to run. In case the time exceeds the given threshold, the search query stops and an error message is returned (see error codes table).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"abortOn=the maximum number of allowed results. In case the number exceeds the given threshold, the search query stops and an error message is returned (see error codes table).","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]},{"type":"paragraph","content":[{"text":"The following is the XML structure of the API execution response (pagination = false):","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n[URL_TO_RESULT_FILE]\n\n\n\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The following is the XML structure of the API execution response (pagination = true):","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n[URL_TO_RESULT_FILE]\n\n\n\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"fe6a5d69-4b3b-4c33-8ed9-bd4c4c1c2f44"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Tag Path","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"APIResult","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"General document root tag","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Status","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"The state of the API execution. Optional values OK/Fail","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Url","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"Exists only when the status is OK.","type":"text"},{"type":"hardBreak"},{"text":"The URL to a file containing the API execution result.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Message","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"Exists only when the status is Fail.","type":"text"},{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Data","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1645.0]},"content":[{"type":"paragraph","content":[{"text":"Contains the API execution result.","type":"text"},{"type":"hardBreak"},{"text":"Note: When the result format is CSV, the content of the tag will be wrapped with CDATA.","type":"text"},{"type":"hardBreak"},{"text":"Note: If the execution result is larger than the system-configured limit, the tag will not contain the execution result. Instead, the content of the tag should be used to access the execution result file.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"wide","width":1800.0,"localId":"7a0c4815-82e5-438a-9d05-8aa4eaa7f691"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"Error Code","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Internal Error: An error occurred, please try again. If the problem persists, please contact XPLG support","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Results Exceed Max Allowed Threshold: Result's events count (XXX) is larger than a given limit (XXX)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Request timeout","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Request Canceled: Search API action was canceled","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"5","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[862.0]},"content":[{"type":"paragraph","content":[{"text":"Resources Exceed: Failed to preform search due to limited resource","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Examples ","type":"text","marks":[{"type":"underline"},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"(You need to change machine/port/logs names, ids / folder names, ids / application names, ids if used to be relevant to your environment)","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Returns records matching the search query “error or fail* in logs that their names start with “log4j” in the specified time frame. Result is limited to maximum 1000 log records in csv format:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/view/api/widgetAPI.jsp?widgetId=searchAPI&searchQuery=error or fail* in log.log4j*&startTimeFullStr=01/01/2014 00:00:00&endTimeFullStr=02/02/2014 00:00:00&maxNumOfRecords=1000&resultFormat=csv","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"- Returns records matching the search query “error or exception in in all logs in the last 7 days’ time frame. Result is limited to maximum 1000 log records in xml format:","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/view/api/widgetAPI.jsp?widgetId=searchAPI&searchQuery=error or exception&fixedInterval=last7Days&maxNumOfRecords=1000&resultFormat=xml","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"- ","type":"text","marks":[{"type":"em"}]},{"text":"Returns the complex search query '* in app.Windows Event Logs | count | group by event' result in the last 7 days’ time frame. Result is limited to maximum 1000 entries in csv format. In this example the URL also contains a username and password (admin/admin) that will perform a login to XPLG in order to be able to execute the search query:","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/view/api/widgetAPI.jsp?widgetId=searchAPI&searchQuery=*%20in%20app.Windows%20Event%20Logs%20|%20count%20|%20group%20by%20event&fixedInterval=last7Days&maxNumOfRecords=1000&resultFormat=csv&autoLogin=true&username=admin&password=admin","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-Dashboard"}},"macroMetadata":{"macroId":{"value":"31b7cf00f8e959539b78f271deda99cf"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"d3790815-fdd8-4257-b915-be77b1ea7de1"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns a Dashboards latest result in PDF format","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://[MACHINE_NAME]:[XPLG_PORT]/logeye/view/api/dashboardAPI.jsp?action=export&appName=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]},{"text":"&viewName=","type":"text"},{"text":"[see item 3]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"appName=a name of an existing App in XPLG (case insensitive).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"viewName=a name of an existing Dashboard in XPLG (case insensitive).","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"underline"},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"(You need to change machine/port/logs names, ids / folder names, ids / application names, ids if used to be relevant to your environment)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"- Returns the Dashboard “Dashboard-1” in PDF format","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/view/api/dashboardAPI.jsp?action=export&appName=App-1&viewName=Dashboard-1","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-Search"}},"macroMetadata":{"macroId":{"value":"17452a395ceb162ade99251f5ff26dd9"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"0fc78896-9364-4ea7-9f3f-9b7342591ebe"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL to open Search console on an executed search query","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://[MACHINE_NAME]:[XPLG_PORT]/logeye/search/view/loadSearchModel.jsp?searchQuery=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]},{"text":"&fixedInterval=","type":"text"},{"text":"[see item 3]","type":"text","marks":[{"type":"strong"}]},{"text":"&startTimeFullStr=","type":"text"},{"text":"[see item 4]","type":"text","marks":[{"type":"strong"}]},{"text":"&endTimeFullStr=","type":"text"},{"text":"[see item 4]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchQuery=a query as used in XpoSearch console","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixedInterval=optional values are: last15Minutes, last30Minutes, last60Minutes, last3Hours, last12Hours, last24Hours, last7Days, last14Days, last1Months, last6Months, currentDay, previousDay, currentWeek, previousWeek, allData","type":"text"},{"type":"hardBreak"},{"text":"IMPORTANT","type":"text","marks":[{"type":"strong"}]},{"text":": when using fixedInterval only values from the above list can be provided as is. Optional; if fixedInterval is used then startTimeFullStr and endTimeFullStr should not be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"startTimeFullStr=the start time full string, formatted according to the XPLG system format; default format is MM/dd/yyyy HH:mm:ss ","type":"text"},{"type":"hardBreak"},{"text":"endTimeFullStr=the end time full string, formatted according to the XPLG system format; default format is MM/dd/yyyy HH:mm:ss","type":"text"},{"type":"hardBreak"},{"text":"Optional; used only if fixedInterval is missing; if used, both values are mandatory.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"underline"},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"(You need to change machine/port/logs names, ids / folder names, ids / application names, ids if used to be relevant to your environment)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"- Presents Search console after execution of the search query “error” in the specified time frame:","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/search/view/loadSearchModel.jsp?searchQuery=error&startTimeFullStr=01/01/2014 00:00:00&endTimeFullStr=02/02/2014 00:00:00","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"- Presents Search console after execution of the search query “error” in the specified time frame (last 7 days):","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/search/view/loadSearchModel.jsp?searchQuery=error&fixedInterval=last7Days","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-DataInfo"}},"macroMetadata":{"macroId":{"value":"30e89bcd4e24a71900fb02a422e4cb78"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"80f287e1-7957-4e57-86ad-f77547828361"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns Collected Data Information","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/message/messageJsonApi.jsp?api=collectedDataInfo&type=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]},{"text":"&timeFrame=","type":"text"},{"text":"[see item 3]","type":"text","marks":[{"type":"strong"}]},{"text":"&detailsLevel=","type":"text"},{"text":"[see item 4]","type":"text","marks":[{"type":"strong"}]},{"text":"&maxNumberOfResults=","type":"text"},{"text":"[see item 5]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"underline"}]},{"text":" = fixed string values: AppTags / Folders (default = Folders)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timeFrame","type":"text","marks":[{"type":"underline"}]},{"text":" = fixed string values: last15Minutes, last30Minutes, last60Minutes, last3Hours, last12Hours, last24Hours, last7Days, last14Days, last1Months, last6Months, currentDay, previousDay, currentWeek, previousWeek, allData (default = last24Hours)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"detailsLevel","type":"text","marks":[{"type":"underline"}]},{"text":" = fixed string values: Basic, Detailed","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Basic – returns a JSON specifying: AppTag/Folder based on specified type with AppTag/Folder name, number of defined log and number of collected logs.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/message/messageJsonApi.jsp?api=collectedDataInfo&type=","type":"text"},{"text":"Folders","type":"text","marks":[{"type":"strong"}]},{"text":"&timeFrame=","type":"text"},{"text":"last24Hours","type":"text","marks":[{"type":"strong"}]},{"text":"&detailsLevel=","type":"text"},{"text":"Basic","type":"text","marks":[{"type":"strong"}]},{"text":"&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"paragraph","content":[{"text":"Result JSON","type":"text","marks":[{"type":"underline"}]},{"text":":","type":"text"},{"type":"hardBreak"},{"text":"{\"data\":{\"collectionData\":[{\"totalLogs\":12,\"Folders\":\"XPLG System Logs\",\"collectedLogs\":5},{\"totalLogs\":1,\"Folders\":\"Example Applications,WebLogic 10.0,xplg\",\"collectedLogs\":0},{\"totalLogs\":7,\"Folders\":\"Example Logs\",\"collectedLogs\":0},{\"totalLogs\":5,\"Folders\":\"Linux OS\",\"collectedLogs\":4},{\"totalLogs\":9,\"Folders\":\"Demo,Tomcat,TX_EXAMPLE\",\"collectedLogs\":0},{\"totalLogs\":5,\"Folders\":\"XPLG EC2,jet.XPLG.com,Linux OS\",\"collectedLogs\":4},{\"totalLogs\":4,\"Folders\":\"ID,Tomcat\",\"collectedLogs\":3},{\"totalLogs\":9,\"Folders\":\"WebSphere,Profiles,Server\",\"collectedLogs\":0},{\"totalLogs\":1,\"Folders\":\"Example Applications,WebSphere 6.1.0.0\",\"collectedLogs\":0},{\"totalLogs\":1,\"Folders\":\"CloudXPLG\",\"collectedLogs\":0}]}}","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/message/messageJsonApi.jsp?api=collectedDataInfo&type=","type":"text"},{"text":"AppTags","type":"text","marks":[{"type":"strong"}]},{"text":"&timeFrame=","type":"text"},{"text":"last24Hours","type":"text","marks":[{"type":"strong"}]},{"text":"&detailsLevel=","type":"text"},{"text":"Basic","type":"text","marks":[{"type":"strong"}]},{"text":"&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"paragraph","content":[{"text":"Result JSON","type":"text","marks":[{"type":"underline"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"data\":{\"collectionData\":[{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"Tomcat 5.0.28\"},{\"totalLogs\":22,\"collectedLogs\":0,\"AppTags\":\"PrudentialA\"},{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"XplgWiki\"},\n{\"totalLogs\":4,\"collectedLogs\":3,\"AppTags\":\"Tomcat\"},{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"LogLoud\"},{\"totalLogs\":11,\"collectedLogs\":0,\"AppTags\":\"DASTLab\"},{\"totalLogs\":10,\"collectedLogs\":0,\"AppTags\":\"Example AppTag\"},\n{\"totalLogs\":9,\"collectedLogs\":0,\"AppTags\":\"XPLG\"},{\"totalLogs\":2,\"collectedLogs\":1,\"AppTags\":\"Website\"},{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"LabA_LoadTest\"},\n{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"Audit\"},{\"totalLogs\":24,\"collectedLogs\":0,\"AppTags\":\"AppFinTech_LoadLabA\"},{\"totalLogs\":19,\"collectedLogs\":8,\"AppTags\":\"Linux\"},{\"totalLogs\":5,\"collectedLogs\":4,\"AppTags\":\"Linux OS\"},\n{\"totalLogs\":7,\"collectedLogs\":0,\"AppTags\":\"Weblogic 10.0\"},{\"totalLogs\":10,\"collectedLogs\":0,\"AppTags\":\"VOLoadTesting\"},{\"totalLogs\":2,\"collectedLogs\":0,\"AppTags\":\"Log4J\"},\n{\"totalLogs\":1,\"collectedLogs\":0,\"AppTags\":\"JET-XPLG\"},{\"totalLogs\":9,\"collectedLogs\":0,\"AppTags\":\"WebSphere 6.1\"},{\"totalLogs\":21,\"collectedLogs\":11,\"AppTags\":\"ID\"}]}}\n\n","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Detailed – returns a JSON specifying: AppTag/Folder based on specified type, number of defined logs, number of collected logs and a list of uncollected logs with their sizes in bytes (comma separated full Folders path in XPLG Folders and Logs tree).","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/message/messageJsonApi.jsp?api=collectedDataInfo&type=","type":"text"},{"text":"Folders","type":"text","marks":[{"type":"strong"}]},{"text":"&timeFrame=","type":"text"},{"text":"last24Hours","type":"text","marks":[{"type":"strong"}]},{"text":"&detailsLevel=","type":"text"},{"text":"Detailed","type":"text","marks":[{"type":"strong"}]},{"text":"&maxNumberOfResults=","type":"text"},{"text":"10","type":"text","marks":[{"type":"strong"}]},{"text":"&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"paragraph","content":[{"text":"Result JSON","type":"text","marks":[{"type":"underline"}]},{"text":":","type":"text"},{"type":"hardBreak"},{"text":"{\"data\":{\"collectionData\":[{\"totalLogs\":1,\"Folders\":\"JS.Logloud\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"JS.Logloud,JS.Logloud\",\"dataSize\":250}]},{\"totalLogs\":1,\"Folders\":\"AWS ELB\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"AWS ELB,elasticloadbalancing\",\"dataSize\":3161841}]},{\"totalLogs\":9,\"Folders\":\"Demo,Tomcat,TX_EXAMPLE\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Demo,Tomcat,TX_EXAMPLE,IMPACS_BookingInterface-IMPACS_LoanBooking_ReqRep\",\"dataSize\":104619},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Customer_Search_Response\",\"dataSize\":1482923},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,IMPACS_BookingInterface-IMPACS_LoanBooking_Status\",\"dataSize\":70679},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NAIT_AFS_BookingInterface--AFS_LP_BookingInterface_ResponseMessage\",\"dataSize\":450876},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NAIT_AFS_BookingInterface--LP_AFS_BookingInterface_RequestMessage\",\"dataSize\":374061},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Get_Customer_Request\",\"dataSize\":900789},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Get_Customer_Response\",\"dataSize\":865204},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NESS-LPNameRequesttoNESS\",\"dataSize\":4298295},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NESS-NESSNameResponsetoLP\",\"dataSize\":6681574}]},{\"totalLogs\":4,\"Folders\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,http_error\",\"dataSize\":6201816},{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,http_access\",\"dataSize\":1411665},{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,SystemErr\",\"dataSize\":178297},{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,SystemOut\",\"dataSize\":663867}]},{\"totalLogs\":2,\"Folders\":\"Demo,MySQL\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Demo,MySQL,mysqld-instance-1\",\"dataSize\":184975},{\"path\":\"Demo,MySQL,mysqld-instance-2\",\"dataSize\":8235}]},{\"totalLogs\":2,\"Folders\":\"Example Applications,WebLogic 10.0,wl_server,examplesServer\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Example Applications,WebLogic 10.0,wl_server,examplesServer,examplesServer\",\"dataSize\":1003895},{\"path\":\"Example Applications,WebLogic 10.0,wl_server,examplesServer,access\",\"dataSize\":698}]},{\"totalLogs\":1,\"Folders\":\"WebApp Logs,LogLooud\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"WebApp Logs,LogLooud,LogLooud\",\"dataSize\":1305}]},{\"totalLogs\":2,\"Folders\":\"Demo,Linux,instance1\",\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Demo,Linux,instance1,messages\",\"dataSize\":86974743},{\"path\":\"Demo,Linux,instance1,Mail\",\"dataSize\":23821324}]}]}}","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"http://localhost:30303/logeye/message/messageJsonApi.jsp?api=collectedDataInfo&type=","type":"text"},{"text":"AppTags","type":"text","marks":[{"type":"strong"}]},{"text":"&timeFrame=","type":"text"},{"text":"last24Hours","type":"text","marks":[{"type":"strong"}]},{"text":"&detailsLevel=","type":"text"},{"text":"Detailed&","type":"text","marks":[{"type":"strong"}]},{"text":"maxNumberOfResults=","type":"text"},{"text":"10","type":"text","marks":[{"type":"strong"}]},{"text":"&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"paragraph","content":[{"text":"Result JSON","type":"text","marks":[{"type":"underline"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"{\"data\":{\"collectionData\":[{\"totalLogs\":1,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Example Applications,Tomcat 5.0.28,localhost_log\",\"dataSize\":103891}],\"AppTags\":\"Tomcat 5.0.28\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":1,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"JS.Logloud,JS.Logloud\",\"dataSize\":250}],\"AppTags\":\"JS.Logloud\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":9,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Demo,Tomcat,TX_EXAMPLE,IMPACS_BookingInterface-IMPACS_LoanBooking_ReqRep\",\"dataSize\":104619},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Customer_Search_Response\",\"dataSize\":1482923},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,IMPACS_BookingInterface-IMPACS_LoanBooking_Status\",\"dataSize\":70679},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NAIT_AFS_BookingInterface--AFS_LP_BookingInterface_ResponseMessage\",\"dataSize\":450876},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NAIT_AFS_BookingInterface--LP_AFS_BookingInterface_RequestMessage\",\"dataSize\":374061},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Get_Customer_Request\",\"dataSize\":900789},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,ICV_Customer_Interface--ICV_Get_Customer_Response\",\"dataSize\":865204},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NESS-LPNameRequesttoNESS\",\"dataSize\":4298295},{\"path\":\"Demo,Tomcat,TX_EXAMPLE,NESS-NESSNameResponsetoLP\",\"dataSize\":6681574}],\"AppTags\":\"AppFinTech_LoadLabA\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":14,\"collectedLogs\":5,\"unCollectedLogsData\":[{\"path\":\"Demo,Linux,instance1,messages\",\"dataSize\":86974743},{\"path\":\"Demo,Linux,instance1,Mail\",\"dataSize\":23821324},{\"path\":\"ID,OS,log,boot\",\"dataSize\":0},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"ID,OS,log,dracut\",\"dataSize\":0},{\"path\":\"ID,OS,log,yum\",\"dataSize\":0},{\"path\":\"ID,OS,log,tomcat,catalina log\",\"dataSize\":0},{\"path\":\"ID,OS,log,tomcat,catalina out\",\"dataSize\":0},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"ID,OS,log,tomcat,localhost\",\"dataSize\":0},{\"path\":\"ID,OS,log,tomcat,localhost_access_log\",\"dataSize\":0}],\"AppTags\":\"Linux\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":1,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"CloudXPLG,log,apt,history.log\",\"dataSize\":0}],\"AppTags\":\"DASTLab\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":3,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Example Applications,WebLogic 10.0,wl_server,examplesServer,examplesServer\",\"dataSize\":1003895},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebLogic 10.0,wl_server,examplesServer,access\",\"dataSize\":698},{\"path\":\"Example Applications,WebLogic 10.0,xplg,xplg\",\"dataSize\":8033}],\"AppTags\":\"Weblogic 10.0\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":1,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"CloudXPLG,log,apt,history.log\",\"dataSize\":0}],\"AppTags\":\"VOLoadTesting\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":9,\"collectedLogs\":0,\"unCollectedLogsData\":[{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,http_error\",\"dataSize\":6201816},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,http_access\",\"dataSize\":1411665},{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,SystemErr\",\"dataSize\":178297},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv01,SERVERWINNode01,server1,SystemOut\",\"dataSize\":663867},{\"path\":\"Example Applications,WebSphere 6.1.0.0,WebSphere Merge Log Example\",\"dataSize\":0},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv02,SERVERWINNode02,server1,http_error\",\"dataSize\":3100908},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv02,SERVERWINNode02,server1,http_access\",\"dataSize\":1411665},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv02,SERVERWINNode02,server1,SystemErr\",\"dataSize\":89095},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"Example Applications,WebSphere 6.1.0.0,AppSrv02,SERVERWINNode02,server1,SystemOut\",\"dataSize\":67255}],\"AppTags\":\"WebSphere 6.1\"},","type":"text"},{"type":"hardBreak"},{"text":"{\"totalLogs\":12,\"collectedLogs\":5,\"unCollectedLogsData\":[{\"path\":\"ID,OS,log,boot\",\"dataSize\":0},{\"path\":\"ID,OS,log,dracut\",\"dataSize\":0},{\"path\":\"ID,OS,log,yum\",\"dataSize\":0},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"ID,OS,log,tomcat,catalina log\",\"dataSize\":0},{\"path\":\"ID,OS,log,tomcat,catalina out\",\"dataSize\":0},{\"path\":\"ID,OS,log,tomcat,localhost\",\"dataSize\":0},","type":"text"},{"type":"hardBreak"},{"text":"{\"path\":\"ID,OS,log,tomcat,localhost_access_log\",\"dataSize\":0}],\"AppTags\":\"ID\"}]}}","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maxNumberOfResults","type":"text","marks":[{"type":"underline"}]},{"text":" = number, max number of results to return. Relevant only when ‘","type":"text"},{"text":"Detailed","type":"text","marks":[{"type":"strong"}]},{"text":"’ type is specified (default = 100)","type":"text"}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-FoldersAndLogsInfo"}},"macroMetadata":{"macroId":{"value":"7baf61a787c5e9965267bdc2a146e889"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"80381442-5bf9-4202-96a0-1570d8d62a25"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns Folders and Logs information","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/folders-and-logs-configuration?sourceQuery=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sourceQuery","type":"text","marks":[{"type":"underline"}]},{"text":" = the source query that represent on which part of XPLG data structure to run (Folder(s), appTag(s). For example: apptag.APPTAG_NAME, folder.FOLDER_NAME","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Result example:","type":"text"}]},{"type":"paragraph","content":[{"text":"API call: http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/folders-and-logs-configuration?sourceQuery=apptag.TEST&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"codeBlock","content":[{"text":"Result: {\"success\":true,\"errorMessage\":null,\"response\":{\"selected\":false,\"id\":\"Module-rootModule\",\"name\":\"Folders and Logs\",\"description\":\"\",\"type\":\"Module\",\"key\":null,\"hasChildrens\":true,\"children\":[{\"selected\":false,\"id\":\"Module-1227520005721\",\"name\":\"Example Logs\",\"description\":\"\",\"type\":\"Module\",\"key\":null,\"hasChildrens\":true,\"children\":[{\"selected\":false,\"id\":\"Log-Log4J_Log_1227520538204\",\"name\":\"Log4J Log\",\"description\":\"\",\"type\":\"Log\",\"key\":null,\"hasChildrens\":false,\"children\":[]},{\"selected\":false,\"id\":\"Log-IIS_Log_1227520737065\",\"name\":\"IIS Log\",\"description\":\"\",\"type\":\"Log\",\"key\":null,\"hasChildrens\":false,\"children\":[]},{\"selected\":false,\"id\":\"Log-Syslog_Log_1227521086597\",\"name\":\"Syslog Log\",\"description\":\"\",\"type\":\"Log\",\"key\":null,\"hasChildrens\":false,\"children\":[]},{\"selected\":false,\"id\":\"Module-1509627171374\",\"name\":\"ssh\",\"description\":\"\",\"type\":\"Module\",\"key\":null,\"hasChildrens\":true,\"children\":[{\"selected\":false,\"id\":\"Log-ssh_1509627248381\",\"name\":\"ssh\",\"description\":\"\",\"type\":\"Log\",\"key\":null,\"hasChildrens\":false,\"children\":[]},{\"selected\":false,\"id\":\"Module-1509611724539\",\"name\":\"New Example Logs\",\"description\":\"\",\"type\":\"Module\",\"key\":null,\"hasChildrens\":true,\"children\":[{\"selected\":false,\"id\":\"Log-XPLGlog_1509628193290\",\"name\":\"XPLGlog\",\"description\":\"\",\"type\":\"Log\",\"key\":null,\"hasChildrens\":false,\"children\":[]}]}]}]}]},\"httpStatusCode\":0}","type":"text"}]},{"type":"paragraph","content":[{"text":"Name = the name of the object in the Folders and Logs tree","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"id = the id in XPLG of object in the Folders and Logs tree","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"description = the description of the object in the Folders and Logs tree","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"type = the type (log/folder) of the object in the Folders and Logs tree","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"* For each Folder - if there are subfolders / logs then they will be listed indicated by hasChildrens = true and children JSON object with the details.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-LogInfo"}},"macroMetadata":{"macroId":{"value":"307d8f70cb87ead71dd2faa47e417383"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"30cb2a00-10e5-4890-86f7-286ad1816a70"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns a specific log's information","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/log-configuration?logPath=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]},{"text":"&logName=","type":"text"},{"text":"[see item 3]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"logPath","type":"text","marks":[{"type":"underline"}]},{"text":" = the Folders path in XPLG to the log separated by '->', without the log name, case sensitive. For example: ROOT->FOLDER_1->FOLDER_2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"logName","type":"text","marks":[{"type":"underline"}]},{"text":" = the log name, case sensitive.","type":"text"},{"type":"hardBreak"}]}]}]},{"type":"paragraph","content":[{"text":"Result example:","type":"text"}]},{"type":"paragraph","content":[{"text":"API call: http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/log-configuration?logPath=ROOT-%3EExample%20Logs&logName=IIS%20Log&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"codeBlock","content":[{"text":"Result: {\"success\":true,\"errorMessage\":null,\"response\":{\"type\":\"Log\",\"id\":\"Log-IIS_Log_1227520737065\",\"name\":\"IIS Log\",\"description\":\"\",\"path\":null,\"appTags\":null,\"collectionPolicy\":\"defaultLogCollectionPolicy\",\"patterns\":\"{date:Date,locale=en,dd-MM-yyyy HH:mm:ss.SSS} {text:c-ip} {text:cs-username} {text:s-sitename} {text:s-computername} {ip:s-ip} {text:s-port} {text:cs-method} {text:cs-uristem} {text:cs-uri-query} {number:sc-status} {text:sc-win32-status} {text:sc-bytes} {text:time-taken} {text:cs-version} {text:cs-host} {text:cs(User-Agent)} {text:cs(Cookie)} {text:cs(Referer)}\",\"filePaths\":[\"IIS.log\"],\"accountName\":null,\"charSet\":null,\"timeZone\":\"Israel Standard Time\",\"dataFilterQuery\":null},\"httpStatusCode\":0}","type":"text"}]},{"type":"paragraph","content":[{"text":"type = the type of log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"id = the id of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"name = the name of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"description = the description of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"path = the Folders and Logs path of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"appTags = the appTags that the log is tagged to (if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"collectionPolicy = the name of the collection policy that the log is part of","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"patterns = the data patterns applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"filesPath = the absolute path to the files that the log is defined on, separated by ","type":"text","marks":[{"type":"em"}]},{"text":"@#@# if there are multiple locations configured ","type":"text"},{"text":"(if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"accountName = the name of the account that the log is using (if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"charSet = the char-set applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"timeZone = the time zone applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"dataFilterQuery = the data filter query applied on the log (if applicable)","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"XPLGAPI-LogsDetailedInfo"}},"macroMetadata":{"macroId":{"value":"9f38234121bc2935bd2855c95d785603"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"f1ac2e54-888d-4af0-b808-4da82437735e"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL that returns multiple log's information","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns the complete details of the logs based on the source query as listed below.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/logs-configuration?sourceQuery=","type":"text"},{"text":"[see item 2]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sourceQuery","type":"text","marks":[{"type":"underline"}]},{"text":" = the source query that represent on which part of XPLG data structure to run (Folder(s), appTag(s). For example: apptag.APPTAG_NAME, folder.FOLDER_NAME","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Result example:","type":"text"}]},{"type":"paragraph","content":[{"text":"API call: http://","type":"text"},{"text":"[MACHINE_NAME]","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":"[XPLG_PORT]","type":"text","marks":[{"type":"strong"}]},{"text":"/logeye/restapi/logs-configuration?sourceQuery=folder.Example%20Logs&autoLogin=true&username=admin&password=admin","type":"text"}]},{"type":"codeBlock","content":[{"text":"type | id | name | description | path | appTags | collection policy | patterns | files paths | account name | char set | time zone | data Filter Query\nLog | Log-Acute_Dispatch_1525684585842 | Acute Dispatch | | ROOT->Logs Information->Acute Dispatch | LogsInformation | Default Collection Policy | {text:type} | {text:id} | {text:name} | {text:description} | {text:path} | {text:appTags} | {text:collection policy} | {text:patterns} | {text:files paths} | {text:account name} | {text:char set} | {text:time zone} | {text:data Filter Query} | C:\\Users\\omry.XPLG\\Desktop\\FMC\\LexLogsInformation\\Acute Dispatch.txt | null | null | Asia/Jerusalem | null","type":"text"}]},{"type":"paragraph","content":[{"text":"type = the type of returned object","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"id = the id of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"name = the name of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"description = the description of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"path = the Folders and Logs path of the log in XPLG","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"appTags = the appTags that the log is tagged to (if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"collectionPolicy = the name of the collection policy that the log is part of","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"patterns = the data patterns applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"filesPath = the absolute path to the files that the log is defined on, separated by ","type":"text","marks":[{"type":"em"}]},{"text":"@#@# if there are multiple locations configured ","type":"text"},{"text":"(if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"accountName = the name of the account that the log is using (if applicable)","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"charSet = the char-set applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"timeZone = the time zone applied on the log","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"dataFilterQuery = the data filter query applied on the log (if applicable)","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"You can parse this data in XPLG using the following pattern:","type":"text","marks":[{"type":"em"}]}]},{"type":"codeBlock","content":[{"text":"{text:type} | {text:id} | {text:name} | {text:description} | {text:path} | {text:appTags} | {text:collection policy} | {string:patterns} | {string:files paths} | {text:account name} | {text:char set} | {text:time zone} | {text:data Filter Query}","type":"text"}]}],"version":1}

Browser not supported