Search¶

Search - FetchSearchLogs¶

Fetch all search logs based on given conditions

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Search/logs/fetch

Parameter

Field	Type	Description
limit	int	The maximum number of rows returned in a single request. The default value of the limit parameter is 100. Optional Field
query	String	Valid LogPoint query to filter the response based on the given query. Mandatory Field
repos	[String]	List of repos where the logs are searched. Fetch the list of available repos using the Repos - FetchRemoteRepos API. The endpoint returns logs from all the permitted repos if the repos parameter is absent in the request. Optional Field
time_range	[String]	Starting and ending Unix time stamp to define the time range for the logs. The endpoint returns the logs that were recorded between the given time range. Mandatory Field
user_id	String	Existing User id. Fetch the list of users with the Users - List API. Mandatory Field

Request Example

{
    "data": {
        "limit": 100,
        "query": "| chart count() by device_ip",
        "repos": [
            "127.0.0.1:5504/_logpoint",
            "10.4.0.1:5504/_logpoint"
        ],
        "time_range": [
            "880968071",
            "1637832071"
        ],
        "user_id": "5d88c559d8aaa42d8c4bfc41"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}/{data_node}"
}

Helpful?