Home

Data APIs

The query types fall in the following categories:

  • KPIs

All output timestamps are in EPOCH. Be sure to substitute your local host for UNRAVEL_HOST.

KPIs
curl -X GET "http://UNRAVEL_HOST:3000/api/v1/reports/data/kpis?numDays=NumDays" -H "accept: application/json" -H "Authorization: JWT token"

Required parameters are:

numDays: number of days

Schema

[
  {
    "st": start time EPOCH_timestamp,
    "et": end time EPOCH_timestamp,
    "nlaTb": # of tables accessed,
    "nlaPr": # of partitions accessed,
    "nlaQr": # of queries accessing the table,
    "nlaRi": Total Read I/O due to accessing the Tables,
    "nlcTb": # of tables created,
    "nlcPr": # of partitions created,
    "nlcTz": size of tables created,
    "nlcPz": size of partitions created,
    "ntoTb": total number of tables in the system,
    "ntoPr": total number of partitions in the system,
    "nhtTb":  ,
    "nwaTb":  ,
    "ncoTb":  ,
    "nhtPr":  ,
    "nwaPr":  ,
    "ncoPr":  ,
    "rp":  ,
    "rs":  ,
    "fs":  ,
    "users": [
      // comma separated list of users
    ]
  }
]
curl -X GET "http://localhost:3000/api/v1/reports/data/kpis?numDays=1" -H  "accept: application/json" -H  "Authorization: JWT token"

Sample Output

[
  {
    "st": 1536795705,
    "et": 1536882105,
    "nlaTb": 15,
    "nlaPr": 0,
    "nlaQr": 57,
    "nlaRi": 101489411821,
    "nlcTb": 7,
    "nlcPr": 0,
    "nlcTz": 304768890,
    "nlcPz": 0,
    "ntoTb": 378,
    "ntoPr": 30061,
    "nhtTb": 19,
    "nwaTb": 0,
    "ncoTb": 359,
    "nhtPr": 1823,
    "nwaPr": 0,
    "ncoPr": 28238,
    "rp": 30061,
    "rs": 92544293666,
    "fs": 92544293666,
    "users": [
      "root",
      "hdfs"
    ]
  }
]
In this section: