Retrieve audit events
Get a series of audit events describing changes made to your Vonage API account over time.
get/events
Query parameters
event_type'USER_STATUS' | 'USER_UPDATE' | 'USER_BILLING_UPDATE' | 'USER_CREATE' | 'USER_LOGIN' | 'USER_LOGOUT' | 'USER_PRODUCT_SEARCH' | 'USER_API_KEYS_UPDATE' | 'ACCOUNT_SECRET_DELETE' | 'ACCOUNT_SECRET_CREATE' | 'ACCOUNT_UPDATE_SPAMMER' | 'ACCOUNT_UPDATE_SETTINGS_API' | 'NUMBER_ASSIGN' | 'NUMBER_UPDATED' | 'NUMBER_RELEASE' | 'NUMBER_LINKED' | 'NUMBER_UNLINKED' | 'APP_CREATE' | 'APP_UPDATE' | 'APP_DELETE' | 'APP_DISABLE' | 'APP_ENABLE' | 'IP_WHITELIST_CREATE' | 'IP_WHITELIST_DELETE' | 'AUTORELOAD_ENABLE' | 'AUTORELOAD_UPDATE' | 'AUTORELOAD_DISABLE'
The type of the audit event.
Example:APP_CREATE
Filter results by this event type.
date_fromstring
Start of time range for audit events. DateTime in ISO-8601 format.
date_tostring
End of time range for audit events. DateTime in ISO-8601 format.
search_textstring
Return only audit events where the JSON object contains this search text. Must be legal text for a JSON attribute value, that is quotes and braces must be escaped.
pagestring
Page number starting with page 1.
sizeinteger
Number of elements per page.
Response
OK
Example response
{
"_embedded": {
"events": [
{
"_links": {
"self": {
"href": "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"account_id": "abcd1234",
"context": {
"appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"created": {
"accountId": "abcdef01",
"answer_url": {
"method": "GET",
"url": "https://example.org/my-app-callback"
},
"appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"event_url": {
"method": "GET",
"url": "https://example.org/my-app-callback"
},
"name": "My Voice App",
"type": "voice"
}
},
"created_at": "2018-07-04T11:41:32",
"event_type": "APP_CREATE",
"event_type_description": "Application created.",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"source": "CD",
"source_country": "GB",
"source_description": "Customer Dashboard",
"source_ip": "192.0.2.0",
"user_email": "user@example.org",
"user_id": 1234567
}
]
},
"_links": {
"last": {
"href": "http://api.nexmo.com/beta/audit/events?page=2&size=30"
},
"next": {
"href": "http://api.nexmo.com/beta/audit/events?page=2&size=30"
},
"self": {
"href": "http://api.nexmo.com/beta/audit/events"
}
},
"page": {
"number": 1,
"size": 100,
"totalElements": 120,
"totalPages": 2
}
}