/logstash/pipelines/{pipeline}/kpis
Returns the KPIs of a specific pipeline.
Request
GET http://unravel-host:3000/api/v1/logstash/pipelines/{pipeline}/kpis?start_time={date}&end_time={date}&metrics={value}
Path parameters
Name | Type | Description |
|---|---|---|
| string | Name of the pipeline. |
Query parameters
Name | Type | Description |
|---|---|---|
| string | Start date for report. Format: YYYY-MM-DD |
| string | End date for report. Format: YYYY-MM-DD |
| CSL | Use a comma separated list to retrieve both metrics. pipeline_num_events_in: Number of events pipeline_num_events_out: Number of events |
Response body
Name | Type | Description | ||
|---|---|---|---|---|
metric | array | |||
| timestamp | Timestamp | ||
| int | Value of the metrics for a given timestamp. | ||
| int | |||
Example
Request for both metrics:
curl -X GET "http://node.mycompany.com:3000/api/v1/logstash/pipelines/main/kpis?start_time=2020-01-01&end_time=2010-04-01&metrics=pipeline_num_events_in,pipeline_num_events_out" -H "accept: application/json" -H "Authorization: JWT tokenResponse:
{
"events_in":[
{"ts":1585742400000,"val":4001,"deriv_val":0},
{"ts":1585753200000,"val":4001,"deriv_val":0},
{"ts":1585764000000,"val":4001,"deriv_val":0}
],
"events_out":[
{"ts":1585742400000,"val":0,"deriv_val":0},
{"ts":1585753200000,"val":0,"deriv_val":0},
{"ts":1585764000000,"val":0,"deriv_val":0}
]
}