OrganisationReports
Organisation Authentication log report
This endpoint returns a report of all authentication logs for the organisation.
get/shop/reports/organisation/authentication-log
Query parameters
date_fromstring date required
The date from which to start the report.
date_tostring date required
The date to which to end the report.
authenticatable_idstring uuid
Optional user filter. When provided, only authentication events for the given user are returned; omit to see every authentication attempt across the organisation in the date range.
login_successfulboolean
Filter the report by whether the login was successful or not.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
Contains the report data
Example response
{
"data": [
{
"ip_address": "127.0.0.1",
"user": "John Doe",
"login_successful": true
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.