Code Block | ||
---|---|---|
| ||
GET /es/api/v1/stats/id/{stat_id} |
Code Block |
---|
{ "engine_id": "search-1710972953954.685", "id": "search", "worker_id": "584", "execution_id": "1710972953954.685", "server_id": "encrypted:q5LnUhxp7uk9C6O/TKuixg==:em165TSJ3GuMiXR5PBgL", "stats_type": "pipeline", "since": "2024-03-20T16:16:04.635765", "count": 0, "average": 0.0, "minimum": 0.0, "maximum": 0.0, "failure_count": 0, "init_count": 1, "init_average": 0.529282, "init_minimum": 0.529282, "init_maximum": 0.529282, "modified_date": "2024-03-20T16:16:04.635765", "stage_count": 5 } |
Code Block |
---|
{ "detail": "Stat ID: <stat_id> does not exist." } |
This route has the ability to get a list of stats by type (stage, pipeline or endpoint). It receives the type as a string and returns a JSON object with all the stat properties of the type searched.
Also, you set the list size and the sort_by options to customize the response.
Parameter | Type | Description |
---|---|---|
stat_type | string | Statistic type to get data from. |
Parameter | Type | Description | Required |
---|---|---|---|
size | integer | Size limit for results. | No |
sort_by | string | Stat property value to sort results by. | No |
sorting_asc | bool | To sort results from low to high. (Default is descending sort) | No |
Code Block | ||
---|---|---|
| ||
GET /es/api/v1/stats/{stat_type} |
Code Block | ||
---|---|---|
| ||
GET /es/api/v1/stats/{stat_type}?size=10 |
Code Block | ||
---|---|---|
| ||
[ { "engine_id": "search-highlight-1710972953954.685", "id": "search-highlight", "worker_id": "584", "execution_id": "1710972953954.685", "server_id": "encrypted:q5LnUhxp7uk9C6O/TKuixg==:em165TSJ3GuMiXR5PBgL", "stats_type": "stage", "since": "2024-03-20T16:16:04.636764", "count": 0, "average": 0.0, "minimum": 0.0, "maximum": 0.0, "failure_count": 0, "init_count": 1, "init_average": 0.0, "init_minimum": 0.0, "init_maximum": 0.0, "process_count": 0, "process_average": 0.0, "process_minimum": 0.0, "process_maximum": 0.0, "post_process_count": 0, "post_process_average": 0.0, "post_process_minimum": 0.0, "post_process_maximum": 0.0, "modified_date": "2024-03-20T16:16:04.636764", "stage_count": 0 }, ..., { "engine_id": "search-search-1710974449010.7778", "id": "search-search", "worker_id": "28172", "execution_id": "1710974449010.7778", "server_id": "encrypted:0wrUU8puI3BeuhDpOvwzJQ==:P8+beW8Q0UUpj5nmJTtq", "stats_type": "stage", "since": "2024-03-20T16:41:15.238136", "count": 0, "average": 0.0, "minimum": 0.0, "maximum": 0.0, "failure_count": 0, "init_count": 1, "init_average": 0.564749, "init_minimum": 0.564749, "init_maximum": 0.564749, "process_count": 0, "process_average": 0.0, "process_minimum": 0.0, "process_maximum": 0.0, "post_process_count": 0, "post_process_average": 0.0, "post_process_minimum": 0.0, "post_process_maximum": 0.0, "modified_date": "2024-03-20T16:41:15.238136", "stage_count": 0 } ] |
This route has the ability to get a list of all stored stats (stages, pipelines and endpoints).
Also, you set the list size and the sort_by options to customize the response.
Info |
---|
This endpoint does not have parameters. |
Parameter | Type | Description | Required |
---|---|---|---|
size | integer | Size limit for results. | No |
sort_by | string | Stat property value to sort results by. | No |
sorting_asc | bool | To sort results from low to high. (Default is descending sort) | No |
Code Block | ||
---|---|---|
| ||
GET /es/api/v1/stats/all |
Code Block | ||
---|---|---|
| ||
GET /es/api/v1/stats/all?size=10 |
Code Block | ||
---|---|---|
| ||
[ { "engine_id": "search-highlight-1710972953954.685", "id": "search-highlight", "worker_id": "584", "execution_id": "1710972953954.685", "server_id": "encrypted:q5LnUhxp7uk9C6O/TKuixg==:em165TSJ3GuMiXR5PBgL", "stats_type": "stage", "since": "2024-03-20T16:16:04.636764", "count": 0, "average": 0.0, "minimum": 0.0, "maximum": 0.0, "failure_count": 0, "init_count": 1, "init_average": 0.0, "init_minimum": 0.0, "init_maximum": 0.0, "process_count": 0, "process_average": 0.0, "process_minimum": 0.0, "process_maximum": 0.0, "post_process_count": 0, "post_process_average": 0.0, "post_process_minimum": 0.0, "post_process_maximum": 0.0, "modified_date": "2024-03-20T16:16:04.636764", "stage_count": 0 }, ..., { "engine_id": "search-search-1710974449010.7778", "id": "search-search", "worker_id": "28172", "execution_id": "1710974449010.7778", "server_id": "encrypted:0wrUU8puI3BeuhDpOvwzJQ==:P8+beW8Q0UUpj5nmJTtq", "stats_type": "stage", "since": "2024-03-20T16:41:15.238136", "count": 0, "average": 0.0, "minimum": 0.0, "maximum": 0.0, "failure_count": 0, "init_count": 1, "init_average": 0.564749, "init_minimum": 0.564749, "init_maximum": 0.564749, "process_count": 0, "process_average": 0.0, "process_minimum": 0.0, "process_maximum": 0.0, "post_process_count": 0, "post_process_average": 0.0, "post_process_minimum": 0.0, "post_process_maximum": 0.0, "modified_date": "2024-03-20T16:41:15.238136", "stage_count": 0 } ] |