Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Schema

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.

...