Audit Metrics Endpoints

Documentation for the Endpoints used for Tracker Audit Metrics

MethodPathRequest TypeParamsSample Response
Top N entitiesv1/auditmetrics/top-entities/{entity-name}GET

Path Params

'entity-name' :

  • 'datasets' (Includes Streams)
  • 'programs'
  • 'applications'

Query Params

  • limit
  • entityName
  • entityType
  • startTiime
  • endTime

All queries optional

Dataset Response:

[
{
"entityName": "test_stream",
"entityType": "stream",
"read": 3,
"write": 0
},
{
"entityName": "test_table",
"entityType": "dataset",
"read": 0,
"write": 3
}
]

Program Response:

[
{
"entityName": "phase-1",
"application": "pipeline_test",
"programType": "program_run",
"value": 6
},
{
"entityName": "phase-2",
"application": "pipeline_test",
"programType": "program_run",
"value": 5
}
]

Application Response:

[
{
"entityName": "pipeline_test",
"value": 6
},
{
"entityName": "pipeline_1",
"value": 1
}
]

Time Since Last Actionv1/auditmetrics/time-sinceGET

Query Params

  • entityName
  • entityType


All queries required

{
"read": 12498613
"update": 23434
"truncate":23423
}
Audit Log Histogramv1/auditmetrics/audit-histogramGET

Query Params

  • entityName
  • entityType
  • startTime
  • endTime

All queries optional

{
"results": [
{
"timestamp": 1467331200,
"value": 2
},
{
"timestamp": 1467676800,
"value": 4
},
{
"timestamp": 1467763200,
"value": 22
},
{
"timestamp": 1467849600,
"value": 2
},
{
"timestamp": 1467936000,
"value": 5
},
{
"timestamp": 1468368000,
"value": 16
},
{
"timestamp": 1468540800,
"value": 35
}
],
"bucketInterval": "DAY"
}