The metrics API provides various metrics information
Creates basic crawl metrics report from the audit index. This endpoint needs the ADMINISTRATOR role to be executed.
GET /aspire/_api/metrics/:seedId/:crawlId
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
seedId | string | Required | The seed id |
crawlId | string | Required | The crawl id |
Response
{ "crawl-metrics": { "seedId": "0dda9332-ca52-44e1-ba63-95e51b46f951", "crawlId": "1658154843524", "metrics": { "add": 3, "enqueued": 4, "crawlBegin": 1, "scanned": 1, "crawlEnd": 1, "scannedNotIndexed": 1, "controlItem": 4 }, "workerDistribution": [ { "workerId": "worker_192.168.112.1:41443//AAABghGLnak=", "metrics": { "add": 3, "enqueued": 4, "crawlBegin": 1, "scanned": 1, "crawlEnd": 1, "scannedNotIndexed": 1, "controlItem": 4 } } ] } }
Status: 200
Creates jobs performance statistics report from the audit index. This endpoint needs the ADMINISTRATOR role to be executed.
POST /aspire/_api/metrics/getJobsStatistics
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
size | number | Optional | How many audit items should be viewed in the report. This does not affect the aggregation part of the report. (default = 0) |
aggSource | string | Optional | The audit item "metrics" parts selected for aggregation. Can be different workflow stages, workflow events or the workflow itself. Internal ids are required. Please see the audit index items for the (default = root) |
aggSortField | string | Optional | How to sort audit items requested by the "size" parameter. Descending order is used. (default = sumExecutionTime). Options: maxStageExecutionTime, minStageExecutionTime, avgStageExecutionTime, sumExecutionTime, countStages |
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the batch(es) to be acknowledged |
Examples
Acknowledge a single batch
PUT /aspire/_api/manager/batch/ack/AAABcID5GBc=?type=scan PUT /aspire/_api/manager/batch/ack?type=scan { "id": ["AAABcID5GBc="] }
Acknowledge multiple batches
PUT /aspire/_api/manager/batch/ack?type=scan { "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status: 200, 404