APapinizer
ProjectReports

Lists consumers and API clients that produced no traffic

Changed on

Consumer identities and the API client keys they own, with their creation date, last request and status, for the given environment and period. A null lastUsedAt means no request inside the retained traffic log, NOT necessarily never used - read coverage.dataAvailableFrom before acting on it.

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

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).

organizationCodestring[]

Consumer organization codes; repeat the parameter to pass more than one.

statusstring

Consumer status filter: ALL, ENABLED or DISABLED.

includeApiClientsboolean

Whether API client (key) rows are included. Default true.

identityTypestring

Restricts the answer to one row kind: CONSUMER or API_CLIENT.

minUsageinteger

Lowest request count a row may have. Default 0.

maxUsageinteger

Highest request count a row may have.

pageinteger

Zero-based page index.

sizeinteger

Rows per page.

sortstring

field[,asc|desc] over lastUsedAt, createdAt, consumer, apiClientKey, status, identityType, total.

Response

successful operation!

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

Example response

{
  "items": [
    {
      "identityType": "API_CLIENT",
      "status": "ACTIVE"
    }
  ],
  "coverage": {
    "warning": "apinizerManagerApp.inactiveClients.coverageWarning"
  }
}

Changes