In this building block you see how to get a list of audit events with filtering.
You can filter the list of event objects returned by using query parameters. The parameters that can be specified are shown in the following table:
||The type of the audit event, for example:
||JSON compatible search string. Look for specific text in an audit event.|
||Retrieve audit events from this date (in ISO-8601 format).|
||Retrieve audit events to this date (in ISO-8601 format).|
||Page number starting with page 1.|
||Number of elements per page (between 1 and 100, default 30).|
You will need to ensure that the following replaceable values are set in the example code using any convenient method:
||Your Nexmo API key.|
||Your Nexmo API secret.|
||Some JSON compatible text to search for, for example "number".|
||Audit events starting from this ISO-8601 datetime value. For example, "2018-07-01".|
||Audit events up to this ISO-8601 datetime value. For example, "2018-08-01"|
In the following example the Create an application and Initialize your dependencies procedures are optional.
Create an application
A Nexmo application contains the required configuration for your project. You can create an application using the Nexmo CLI (see below) or via the dashboard . To learn more about applications see our Nexmo concepts guide.
Install the CLI
$ npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Nexmo application. Run the following command and make a note of the application ID that it returns. This is the value to use in
NEXMO_APPLICATION_ID in the example below. It will also create
private.key in the current directory which you will need in the Initialize your dependencies step
Nexmo needs to connect to your local machine to access your
answer_url. We recommend using ngrok
to do this. Make sure to change
demo.ngrok.io in the examples below to your own ngrok URL.
$ nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/events --keyfile private.key
Initialize your dependencies
Create a file named
get-events-with-filtering.sh and add the following code:
Add the following to
curl "https://api.nexmo.com/beta/audit/events?search_text=$SEARCH_TEXT&date_from=$DATE_FROM&date_to=$DATE_TO" \ -u "$NEXMO_API_KEY:$NEXMO_API_SECRET"
Save this file to your machine and run it:
Run the command in a shell. The call will retrieve a filtered list of audit events.