APapinizer
ProjectReports

Lists endpoints that received no requests

Changed on

Every endpoint of the project's API proxies with the requests it served in the period, so the unused ones can be found. An endpoint carries its HTTP method, which is what tells GET /pet from POST /pet; SOAP operations and the method-less proxy kinds (reverse proxy, mirror, connector) answer httpMethod=null and endpoint="/". Pass maxUsage=0 for the strictly unused ones. counts.total=0 means no request inside the retained traffic log, NOT necessarily never called - read coverage.dataAvailableFrom before retiring an API.

get/apiops/projects/{projectName}/reports/inactive-endpoints

Request

Path parameters

projectNamestring required

Project name

Query parameters

environmentNamestring required

Environment name whose traffic log is read.

fromstring

Range start, ISO-8601 or Elasticsearch date math (for example now-30d).

tostring

Range end, ISO-8601 or Elasticsearch date math (for example now).

apiProxyNamestring

Restricts the report to one API proxy, by name.

minUsageinteger

Lowest request count a row may have. Default 0.

maxUsageinteger

Highest request count a row may have. Pass 0 for the strictly unused endpoints.

pageinteger

Zero-based page index.

sizeinteger

Rows per page.

sortstring

field[,asc|desc] over apiProxyName, httpMethod, endpoint, total, endpointRef.

Response

successful operation!

status'SUCCESS' | 'FAILURE'
pageinteger
sizeinteger
totalElementsinteger
totalPagesinteger
sortstring[]

Example response

{
  "items": [
    {
      "apiProxyName": "PetstoreProxy",
      "httpMethod": "GET",
      "endpoint": "/pet/{petId}"
    }
  ],
  "coverage": {
    "warning": "apinizerManagerApp.inactiveClients.coverageWarning"
  }
}

Changes