Retrieve audit events

You can retrieve a record of all audit events associated with your Vonage account. You can also filter this list based on dates, keyword, user and event type.

In this tutorial

You will see how to retrieve a filtered list of audit events:

• Prerequisites
• Retrieve a list of audit events
• Retrieve a filtered list of audit events
• Retrieve a specific audit event
• Conclusion
• Resources

Prerequisites

In order to work through this tutorial you'll need:

• A Vonage account.
• A Terminal application running into which you can type or paste Curl commands. Alternatively you could use Paw, Postman or a similar application.
• You will need to know your VONAGE_API_KEY and VONAGE_API_SECRET which you can obtain from your dashboard.

You can also refer to the Audit API documentation.

Retrieve a list of audit events

To receive a list of all audit events enter the following into your terminal:

$ curl "https://api.nexmo.com/beta/audit/events" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

When you run this command you will receive a list of all audit events.

Retrieve a filtered list of audit events

The list of audit events you receive in the previous step may well be overwhelming, especially if you have been using your Vonage account for some time. You can filter this list based on several parameters:

So for example, to filter based on dates you can enter the following command:

$ curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

This will return all audit events that occurred during August 2018.

You can narrow this down further in various ways. For example you can also filter based on audit event type.

So for example, to find audit events in August of type NUMBER_ASSIGN you could enter the following:

$  curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31&event_type=NUMBER_ASSIGN" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

You can further filter based on search_text. For example to find all audit events containing the text "password" you can enter the following command:

$  curl "https://api.nexmo.com/beta/audit/events?search_text=password" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Retrieve a specific audit event

If you know the UUID for a specific audit event you can retrieve the information for that audit event object. For example if the event UUID is aaaaaaaa-bbbb-cccc-dddd-0123456789ab you would enter:

$ curl "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

This would then return the audit event object JSON for the specified audit event.

Conclusion

Using the filtering capabilities of the Audit API you have complete control regarding the audit events that you retrieve.

Resources

• Audit API docs
• Audit API Reference