Skip to navigation
Management APIReferenceHistory

GetAuditLogAsync

View as Markdown

The [GetAuditLog] asynchronous implementation. Use this function to download a large amounts of data. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.

Allowed roles: Owner.

Example request: Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

from_datestringRequired

The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss

to_datestringRequired

The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss

audit_log_idlist of integersOptional

The audit history ID list separated by semicolons (;)

filtered_admin_user_idstringOptional
The admin user ID to filter
filtered_iplist of stringsOptional

The IP list separated by semicolons (;) to filter

filtered_cmdlist of stringsOptional

The function list separated by semicolons (;) to filter

advanced_filtersstringOptional

A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)

desc_orderbooleanOptionalDefaults to false
Whether to get records in the descent order
with_headerbooleanOptionalDefaults to true

Whether to get a CSV file with the column names if the output=csv

outputstringOptionalDefaults to csv

The output format. The following values available: csv. The default value is csv

Response

Successful response
resultintegerOptional
Returns 1 if the request has been completed successfully
history_report_idintegerOptional
The history report ID