API Usage Logs Overview
Overview:
Dais automatically tracks all events in the Dais API Usage Logs. This allows users to see the details of the API calls involved when a specific event has occurred and shows errors to assist in troubleshooting issues.
Prerequisites:
You will need your products configured with an Event Group and one or more events with corresponding actions configured to begin to see meaningful information in the Usage Logs since they are based on an event being triggered. You will also need to be logged in as a user with the additional “Developer” role enabled.
Navigation:
Go to the “API Tools” tab at the top of the screen and then Usage Logs
- When you first view the page you will see any events that have been triggered in your environment. They will be sorted by Date and Time with the most recent at the top of the page
- The Green button that says
lets you know that the event was successful.
- If the button shows
then you know that event was unsuccessful and requires attention to correct the issue.
- If it shows
there is a potential issue that you should review.
- You can see the details of the API call by clicking on the applicable line.
- You will see the details of the payloads generated in connection with firing that event.
- You can copy that API payload by selecting Copy.
- You can alter the column that appears on the screen by selecting Columns
- You can also search for a specific event or event type using the search bar.
- You can also filter the data by selecting the filter option and entering advanced filtering details.
- Log Tail: Off vs. On - If log tailing is on, you will see events as they are happening in the environment. If it is off you will need to refresh the screen to see the new activity.
What’s Next:
Watch the video below for an in-depth look at how the API Logs work!