API Logs

This page allows Super-Admin and 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 SpamExperts web interface, is done via the API.

  1. Login as a Super-Admin or Admin level user
  2. Navigate to Development > API
  3. Use the Query Rules to filter the results as required
  4. Once you have added the rules, use the Customise dropdown to select the fields you want displayed in the search results

  5. 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
To Match all rules specified ensure that All is selected. Alternatively to allow partial matching select Any:

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
  • On
  • Before
  • After
  • Between
  • Previous
 Date and time selector
Caller IP
  • Matches
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
 Text box; enter Caller IP address to search for
Client Username
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter a username of the client carrying out the action to search for
Client IP
  • Matches
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
 Text box; enter Client IP address to search for
Method -
  • GET
  • POST
  • PUT
  • DELETE
Endpoint
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter Endpoint to search for
HTTP Status
  • Equals
  • Does Not Equal
  • Greater Than
  • Less Than
  • Greater Than Or Equals
  • Less Than Or Equals
 Text box; enter HTTP status code to search for
Error Code
  • Equals
  • Does Not Equal
  • Greater Than
  • Less Than
  • Greater Than Or Equals
  • Less Than Or Equals
 Text box; enter the code of the error to search for
Params
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match

Text box; enter any of the API parameters for the method that would be included in the call to search for, e.g.:

  • fields
  • order_by
Data
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter any relevant data to the API method to search for, for example a username
Extra Params
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter any extra parameters relevant to the API method to search for
Error Class
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter the domain name to search for
Admin
  • Contains
  • Does Not Contain
  • Equals
  • Does Not Equal
  • Starts With
  • Ends With
  • Matches
  • Does Not Match
 Text box; enter the Admin to search for