Rebilly API Docs

Retrieve an API log summary report

Retrieves an API log summary report.

SecuritySecretApiKey or JWT

Request

query Parameters

periodStart required	string <date-time> Date and time when the report starts.
periodEnd required	string <date-time> Date and time when the report ends.
limit	integer [ 0 .. 1000 ] Limits the number of collection items to be returned.
offset	integer >= 0 Specifies the starting point within the collection of items to be returned.

Responses

200

Report retrieved.

Response Schema: application/json

Array of objects

API log summary data.

Array

route	string Route string pattern.
total	integer Total number of requests.
get	integer Total number of `GET` requests.
post	integer Total number of `POST` requests.
put	integer Total number of `PUT` requests.
patch	integer Total number of `PATCH` requests.
delete	integer Total number of `DELETE` requests.
head	integer Total number of `HEAD` requests.
options	integer Total number of `OPTIONS` requests.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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": [{"route": "string",
"total": 0,
"get": 0,
"post": 0,
"put": 0,
"patch": 0,
"delete": 0,
"head": 0,
"options": 0
}
]
}

➔ Next to Retrieve a cumulative subscriptions report