Retrieve a API Log Summary Report

Retrieve a API Log Summary Report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array of objects
Array
route
string

Route string pattern.

total
integer

Total count of requests.

get
integer

Count of GET requests.

post
integer

Count of POST requests.

put
integer

Count of PUT requests.

patch
integer

Count of PATCH requests.

delete
integer

Count of DELETE requests.

head
integer

Count of HEAD requests.

options
integer

Count of OPTIONS requests.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/api-log-summary
Request samples
const params = {
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getApiLogSummary(params);
Response samples
application/json
{
  • "data": [
    ]
}