Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Configuration > Audit Logs > View Web Service API Audit Log

View Web Service API Audit Log

Overview 

You can track the history of API calls made to Aria by following the steps below.

Note: To make API calls to Aria, you must whitelist the IP addresses from which you will be making API calls.

Web Service API Audit Logs

Getting Here: Click Configuration Audit Logs Web Service API

  1. Enter information for any of the fields to search by that parameter.
  • Request Date: The date on which the API call was made to Aria.
  • API Name: The name of the API call that was made to Aria.
  • Account Number: The account number of the customer whose information was updated or retrieved by the API call.
  • Calling IP: The IP address from which the API call was made.
  • Error Code: The error code returned by the API call.
  • Session ID: An Aria-assigned unique identifier for the instance of the API call.
  1. Click Search. Information about API calls display in the following columns:
  • API Name: The name of the API call that was made to Aria.
  • Request Date: The date on which the API call was made to Aria.
  • Elapsed Seconds: The number of seconds that the API call took to complete its task.
  • Account Number: The account number of the customer whose information was updated or retrieved by the API call.
  • Receipt ID: The receipt ID that was passed into the API call (if any).
  • Error Code: The error code returned by the API call.
  • Error Message: The error message returned by the API call.
  • Calling IP: The IP address from which the API call was made.
  • Caller ID: Any additional value that you chose to pass into an API call.
  • Session ID: An Aria-assigned unique identifier for the instance of the API call.

1.png The parameters you searched for display here.
2.png Click Refine Search to update the search parameters.

3.png

The Compare APIs button. To compare 2 to 5 APIs: 

  1. Check the checkbox next to each applicable API. You can check up to 5 APIs.
  2. Click the Compare APIs button. A screen displays with tabs for Details, Input Parameters and Output Parameters.

Details

Input Parameters

Output Parameters

  1. To download the comparison as a CSV file, click Export for each tab
4.png

To view the details of a single API call, click the API name. The details display, including tabs for Details, Input Parameters and Output Parameters.

To download the API call details as a CSV file, click Export for each tab.

You must to post a comment.
Last modified
17:18, 22 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.