Integration Logs

Overview

Integration Logs have been incorporated into the HackerRank experience to allow users to view a record of integration activity between HackerRank and the ATS. The Integration Logs are helpful in troubleshooting integration issues. These Logs are added to the Integrations tab of the Logs page. This provides transparency, and users can inspect and debug the logs with ease.

You can also retrieve logs by applying filters such as date, status, and Request methods.

You will be able to get log results for a custom date range for any ATS integrated with your HackerRank instance and download a report in CSV format.

Note: HackerRank displays logs only for the API calls that are made to the endpoints listed in https://www.hackerrank.com/work/apidocs 

Accessing Integration Logs

Prerequisite

• You must log in as a Company Admin user to access the Integration logs. 

To access the Integration Logs:

1. In the HackerRank home page, click the profile icon on the top-right corner and click Settings.
2. On the left pane, click Logs. The Integration and Audit tabs are displayed.
   
3. Here, you will be able to view the integration logs for the different ATS. To view the log of an ATS, select an ATS.
4. The logs are displayed based on the ATS selected. Note that only those ATS are displayed that have been integrated with HackerRank, recently.
5. You can also search the logs by recruiter email. This is displayed in the details of a log.
6. You can view the following information from the logs:
   • Timestamp: The time when the log is captured.
   • Status: The status of the API call. The values are:
     • Error
     • Success
     • Other
   • Request Method: The method used for the API call. The values are:
     • POST
     • GET
     • PUT
     • DELETE
   • URL Pattern: The URL of the API call. For example, in /x/api/v3/ats/codescreen, the API call used is for Tests.

Viewing an Integration Log

To view the details of an integration log:

1. Click on an individual log.
2. The details of the log are displayed.
3. Each log has these details:
   • Company ID: Identification of the Company
   • Recruiter Email: Email of the Recruiter
   • Admin Email: Email of the Admin
   • User Email: Email of the User
   • Authenticated: Authentication status
   • Status Code: Status code of the API
   • URL: URL of the API call
   • Request UID:
   • Application Name: Name of the ATS

Applying Filters to Retrieve Logs

You can apply filters to retrieve the logs based on the time and date range, status, and API methods.

• Date
• Status
• Request Method

To apply filters to the Integration logs:

1. Click on the filter icon.
2. Now select the appropriate filter based on your requirements.
3. You can also clear the filter applied.

Filter By Date

1. Click the Date drop-down to apply the date filter.
2. You can filter the logs based on All Time logs, other time ranges, and a custom range.

Note: The logs are displayed only for the last 30 days. 

Filter By Status

1. Click the Status drop-down to apply the Status filter. 
2. You can filter the logs based on the Success, Error, and other status of the API calls.

Filter By Request Method

1. 1. Click the Request Method drop-down to apply the Request Method filter. 
   2. You can filter the logs based on the Request Methods: POST, GET, PUT, or DELETE, which are used for the API calls.

Download the Logs

You can download the logs in a CSV format. You can easily save, share, or archive your integration activities for reference or further analysis.

To download the logs:

1. Click the download icon on the top.
2. This will download only the logs displayed on the current page in a CSV file format.