Log

GET`/v1/log/levels`GET /v1/log/levels

Code samples

cURL


# You can also use wget
curl -X GET /v1/log/levels \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log/levels',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/log/levels";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/log/levels

Gets the log levels for the specified date range.

Parameters

Name	In	Type	Required	Description
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none
intervals	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","logLevels":[{"date":"2019-08-24T14:15:22Z","level":"string","count":0}],"groupBy":"string","totalLogLevelEntriesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "logLevels": [
    {
      "date": "2019-08-24T14:15:22Z",
      "level": "string",
      "count": 0
    }
  ],
  "groupBy": "string",
  "totalLogLevelEntriesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLogLevelsResponse

Authentication: API key (x-api-key).

GET`/v1/log`GET /v1/log

Code samples

cURL


# You can also use wget
curl -X GET /v1/log \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/log";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/log

Gets the log entries based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","logEntries":[{"id":0,"message":"string","messageTemplate":"string","level":"string","timeStamp":"2019-08-24T14:15:22Z","exception":"string","properties":"string"}],"totalLogEntriesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "logEntries": [
    {
      "id": 0,
      "message": "string",
      "messageTemplate": "string",
      "level": "string",
      "timeStamp": "2019-08-24T14:15:22Z",
      "exception": "string",
      "properties": "string"
    }
  ],
  "totalLogEntriesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLogResponse

Authentication: API key (x-api-key).

DELETE`/v1/log`DELETE /v1/log

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/log \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/log";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/log

Deletes a log based on the provided request.

Parameters

Name	In	Type	Required	Description
id	query	integer(int32)	false	none
filter	query	string	false	none
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none
deleteAll	query	boolean	false	none

Responses

Status	Meaning	Description
200	OK	The log has been deleted successfully. Example:
{
“Success”: true,
“Message”: “A total of 10 log entries have been deleted.”,
“DeletedLogCount”: 10
}	None

Authentication: API key (x-api-key).

Log

GET/v1/log/levelsGET /v1/log/levels

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/logGET /v1/log

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/logDELETE /v1/log

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET`/v1/log/levels`GET /v1/log/levels

GET`/v1/log`GET /v1/log

DELETE`/v1/log`DELETE /v1/log