Home

/logstash/pipelines/kpis

Returns overall average KPIs for all pipelines in the logstash.

Request
GET http://unravel-host:3000/api/v1/logstash/pipelines/kpis?start_time=(date}&end_time={date}&metric={value}"
Path parameters

None

Query parameters

Name

Type

Description

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

metrics

string

pipeline_num_events_in: Number of events

pipeline_num_events_out: Number of events

Response body

Name

Type

Description

metric

array

list metric

ts

timestamp

Timestamp

val

int

Value of the metrics in a given timestamp.

deriv_val

int

Examples

Request for Metric: kpi_event_in:

curl -X GET "http://node.mycompany.com:3000/api/v1/logstash/pipelines/kpis?start_time=2020-01-01&end_time=2020-04-01&metrics=pipeline_num_events_in" -H; "accept: application/json" -H "Authorization: JWT  token

Response body:

{
  "events_in": [
   {
     "ts": 1585720800000,
     "val": 0,
      "deriv_val": 0
   }
 ]
}

Request for Metric: kpi_event_out:

curl -X GET "http://node.mycompany.com:3000/api/v1/logstash/pipelines/kpis?start_time=2020-01-01&end_time=2020-04-01&metrics=pipeline_num_events_out" -H; "accept: application/json" -H  "Authorization: JWT  token

Response body:

{
  "events_out": [
   {
     "ts": 1585720800000,
     "val": 0,
      "deriv_val": 0
   }
 ]
}
In this section: