API Logs
This page allows Admin level users to view a list of API requests, particularly useful for auditing purposes or if you are attempting to debug a problem. All interactions with the filtering and archiving system, including by the Mail Assure web interface, is done via the API.
- Login as a Admin level user
- Navigate to Development > API
- Use the Query Rules to filter the results as required
- Once you have added the rules, use the Customise dropdown to select the fields you want displayed in the search results
- Click on Show Results to run the search and display the results at the bottom of the page
Query Rules
The Query Rules panel allows you to customise your search filters. The default query rule for the API Log is:
- Method is Post, Put or Delete
- HTTP Status equals 200
Click on + New Rule and select from the filter options available, or amend the existing rules to fit your needs:
Most of the API Query Rules are constructed of three parts:
- The part of the API you are looking for - Select from the first dropdown in the Query Rules panel
- The type of match e.g. contains, does not start with etc. - Select from the second dropdown in the Query Rules panel
- The content you are trying to match
Message Part | Match Type | Content |
---|---|---|
Timestamp |
|
Date and time selector |
Caller IP |
|
Text box; enter Caller IP address to search for |
Client Username |
|
Text box; enter a username of the client carrying out the action to search for |
Client IP |
|
Text box; enter Client IP address to search for |
Method | - |
|
Endpoint |
|
Text box; enter Endpoint to search for |
HTTP Status |
|
Text box; enter HTTP status code to search for |
Error Code |
|
Text box; enter the code of the error to search for |
Params |
|
Text box; enter any of the API parameters for the method that would be included in the call to search for, e.g.:
|
Data |
|
Text box; enter any relevant data to the API method to search for, for example a username |
Extra Params |
|
Text box; enter any extra parameters relevant to the API method to search for |
Error Class |
|
Text box; enter the domain name to search for |
Admin |
|
Text box; enter the Admin to search for |