Project Logs
The Audit Logs section in your dashboard presents the complete history of your project. You can check interactions with Voucherify API sorted by request origin, status, and date. Logs and their filters give you instant access to the account users' and customers' activity, crucial to quick troubleshooting and advanced monitoring of your performance.
Contents
- How does it work?
- Logs overview
- Background tasks overview
- Exports overview
- Available Log filters
- How to search logs with filters?
How does it work?
You have the choice between viewing Logs, Background tasks, and Exports.
Type | Definition |
---|---|
Logs |
Each time you or your customers communicate with our API using the dashboard, API integration, or directly by calling API endpoints, our system logs a new action and presents the called API method with details in the Logs section. |
Background tasks |
Each time you import data into Voucherify or delete a campaign, our system logs a new asynchronous action and presents the details in the Background Tasks. |
Exports |
Our system keeps a record of data exports that were made either from the Dashboard or API. You can view the details of an export and download a copy of a data export. |
Logs overview
You find find logs under the Logs tab.
Each time you or your customers communicate with our API using the dashboard, API integration, or directly by calling API endpoints, our system logs a new action and presents the called API method with details in the Logs section. Logs are project-specific as the authentication of each API call is based on the API keys (set per project).
Click on a log id to display more details, including the API request and response.
There is information on who and when they invoked the given action and what the result was. You can learn more about the related user or customer in the log details and if the action refers to any of your campaigns or incentives.
You can view the API call details, such as query params, request body, and API response body.
By default, the dashboard displays logs from the last 24h. You can change the timeframe and view (from logs to errors) by clicking the current filter and changing it to the desired time range.
Background tasks overview
You will find the background tasks under the Background Tasks tab.
Each time you import data into Voucherify or delete a campaign, our system logs a new asynchronous action and presents the details in the Background Tasks. Background tasks are project-specific as the authentication of each API call is based on the API keys (set per project).
Click on the asynchronous action id to display more details. You can see when the asynchronous action was last updated, the processing time and the progress to completion for tasks that are still running.
You can view information on the status and result of the asynchronous action.
Filters
You can also browse background tasks with more advanced queries created with filters.
Type | Campaign vouchers import Campaign vouchers CSV import Campaign vouchers update Campaign vouchers deletion Campaign vouchers generation Customers CSV import Customers bulk update Customers metadata update Customers metadata key purge |
Products bulk update Products metadata update Products metadata key purge Products CSV import SKUs CSV import Vouchers import Vouchers CSV import Vouchers bulk update Vouchers metadata update Vouchers metadata key |
Status | In Progress Enqueued Failed Done |
Exports overview
You can also navigate to the Audit Log Manager and choose the Exports tab. There you will see a list of your historical exports. By clicking on an export ID, you will be able to view the settings such as filters and parameters that were chosen for the export and have the option to download a copy of the export.
Log filters
You can narrow down the list of logs based on:
Search logs with filters
Click on Find and apply filters in the Logs section.
Choose which log attribute you want to use to build a filter.
Define filtering criteria (1), confirm with the plus (2), and click Apply (3).
You can define many different filters in a single query. When filtering criteria are ready, confirm with Apply to view matching logs.