Other Resources

    EventLog Analyzer API documentation


    This section briefs about the various properties of  EventLog Analyzer API client objects. Take a look at these instructions for EventLog Analyzer API installation. Some snippets for the below described objects and its properties are available here.

     

    Request Objects

    The request objects are used to set the various parameters needed for searching. Below are the request object methods of EventLog Analyzer API

     

    Request Object Parameters

    What does the parameter returns?
    Mandatory Parameters
    long startTime

    This parameter is used to specify the starting time from which the logs are to be searched for a specific criteria (start time window for the search). It should be in the format  "YYYY-mm-dd hh:mm"

    long endTime

    This parameter indicates the time period till which the logs have to be searched for a specific criteria (end time window for the search). It should be in the fomat "YYYY-mm-dd hh:mm".

    Optional Parameters
    string query

    Indicates the input search query 

    integer requiredHitsCount Indicates the number of records returned in each response
    string sortByFieldName

    Sort the search result with respect to the specified field. Not specifying this parameter returns unsorted results.Refer this snippet on how to sort the search results

    string needDistinctOf

    Returns distinct records in the field specified. This snippet to get the distinct search records.

    Parameters for exporting the search results
    boolean CSVNeeded

    Exports the results of the search to a CSV file. Refer this snippet to set the value for this paremeter.

    string CSVPath This parameter is used to specify the path of the filesystem where the CSV file has to be saved
    Parameters for faceting
    string facetByField This parameter returns Top/Bottom 'n' searched fields.
    boolean topFacet Setting this parameter to true returns top 'n' results, whereas  setting this parameter to false returns the bottom 'n' results
    integer facetCount Specifies the number of records returned in the faceted search
    Parameters for performing page search
    PageDetails pagingInfo

    This parameter cannot be set manually. It provides the page information based on the Response Object details.

    boolean forwardSearch

    Setting this parameter to true enables forward pagination. Whereas setting this parameter to false provides backward pagination. Refer to this snippet on how to carry out pagination.

     

     
    Response Object

    A response object is returned as a result of every search. Below are some of the response object methods.

     

    Response Object Parameters What does the parameter returns?
    list<map<<string,string>> result result of specified search query
    long totalCount total number of records for the specified search query
    list<string> searchableFields all the fields that can be searched upon
    list<string> distinctFields distinct field values for the specified field (if it is set)
    list<string> fileList if the search results are exported as a CSV file, then this parameter returns the location of the exported file
    PageDetails pagingInfo information needed for doing page search
    map<string,string> facetFieldValues contains the top/bottom facets and its corresponding count