End Points

Wiki ▸ End Points

Lists

• /api/list/servers : provides a list of servers available to Thoth Index.
  Example response :

{
    "numFound": 1,
    "list": [
        "demo-host"
    ]
}

• /api/list/pools : provides a list of pools available to Thoth Index.
  Example response :

{
    "numFound": 1,
    "list": [
        "demo-pool"
    ]
}

• /api/list/ports : provides a list of ports available to Thoth Index.
  Example response :

{
    "numFound": 1,
    "list": [
        "8900"
    ]
}

• /api/list/cores : provides a list of cores available to Thoth Index.
  Example response :

{
    "numFound": 1,
    "list": [
        "collection1"
    ]
}

Server

Main end-point :

/api/server/:server/core/:core/port/:port/start/:start/end/:end/:information/:attribute

replace:

• :server with hostname
• :core with core name
• :port with port number
• :start start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :end start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :information
  • avg:
    • :attribute:
      • qtime:
      • nqueries:
  • count:
    • :attribute:
      • exception:
      • zeroHits:
      • nqueries:
  • integral:
    • :attribute:
      • exception:
      • zeroHits:
      • nqueries:
  • distribution:
    • :attribute:
      • qtime:

Example response:

curl 'localhost:3001/api/server/demo-host/core/collection1/port/8900/start/NOW-1DAY/end/NOW/integral/nqueries'
{
  "numFound": 1,
  "values": [
    {
      "timestamp": "2014-11-11T00:32:30Z",
      "value": 1244
    }
  ]
}

Pool

Main end-point :

/api/pool/:pool/core/:core/port/:port/start/:start/end/:end/:information/:attribute

replace:

• :pool with pool name
• :core with core name
• :port with port number
• :start start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :end start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :information
  • avg:
    • :attribute:
      • qtime:
      • nqueries:
  • count:
    • :attribute:
      • exception:
      • zeroHits:
      • nqueries:
  • integral:
    • :attribute:
      • exception:
      • zeroHits:
      • nqueries:

Example response:

curl 'localhost:3001/api/pool/demo-pool/core/collection1/port/8900/start/NOW-1DAY/end/NOW/integral/nqueries'
[
    {
        "key": "demo-host",
        "values": [
            [
                "2014-11-11T00:32:30Z",
                1244
            ]
        ]
    }
]

Server exceptions and slow queries

Main end-point :

/api/server/:server/core/:core/port/:port/start/:start/end/:end/:information/:attribute/:page

replace:

• :server with server name
• :core with core name
• :port with port number
• :start start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :end start time (Zulu time - UTC) or Solr syntax (e.g: NOW-1HOUR)
• :information
  • list:
    • :attribute:
      • slowqueries:
        • :page:
      • exception:
        • :page:

Example response:

curl 'localhost:3001/api/server/demo-host/core/collection1/port/8900/start/NOW-1DAY/end/NOW/list/slowqueries/1'
{
  "numFound": 1,
  "values": [
    {
      "timestamp": "2014-11-11T00:47:22.544Z",
      "qtime": 18004,
      "query": "*:*"
    }
    ]
}