Request Logs (for 'Usage' page)

Each log contains the detailed log of an API request. The logs have a lifespan of 30 days.

It is accessible through the following HTTP interface:

Connection HTTP Interface via http://www.example.org/api/connection/requestLogs.

Schema

Name	Description

Name	Description
_id	The id of the request log document.
organisation	The id of the organisation that this request log belongs to.
client	The id of the client that this request log belongs to.
requestStartTime	When this request was made.
requestEndTime	When this request has finished.
requestTimeMs	The number of milliseconds (ms) between the existing requestStartTime and requestEndTime properties for this request.
requestRoute	The path for this request.
requestMethod	The HTTP method for this request.
responseStatusCode	The HTTP response code for this request.
requestUrlParameters	The query params (filter) for this request. Useful for identifying characteristics of a ‘Danger Zone’ request - see below.

The “Usage” Page

This page can be found under Settings → Usage and uses the request logs collection to present the results. Typically, for each API request, we log an entry in the request log collection.

The page has 3 sections:

The response codes indicate the HTTP response codes given for their API requests.
The response time bands indicate how much time their API requests are taking.
The danger zone indicates which individual requests are taking more than 40 seconds.