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 account users' and customers' activity, which is crucial to quick troubleshooting and advanced performance monitoring.
Contents
- How does it work?
- Logs overview
- Background tasks overview
- Exports overview
- Webhook sendouts
- Available Log filters
- How to search logs with filters?
How does it work?
You have the choice between viewing Logs, Background tasks, Exports, and Webhook sendouts.
| 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 made from either the Dashboard or API. You can view the details of an export and download a copy. |
| Webhook sendouts |
Each time you send a webhook, our system keeps a record of that. In the Webhook sendout tab, you can view the webhooks' details or try to re-send them. |
Logs overview
You can 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.
The log details include who and when invoked the given action, the request duration, and the result. You can learn more about the related user or customer in the log details and whether 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 24 hours. 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.
Webhook sendouts overview
In the Webhook sendouts section, you can see a list of all your sent webhooks. You will have an overview of each webhook, including its status, sendout id, URL, request id, and information regarding event creation time and its execution. By clicking on the three dots, you can further explore the details of the webhook sendout data, or in case of any failed attempts, try to re-send the webhook.
Filters
You can browse webhook sendouts with the following filters.
| Filter | Definition |
| ID | This is a webhook sendout ID. |
| Status | There are 3 webhook statuses in total:
|
| Type | Each webhook type is named after a webhook based on appropriate events. The list is also available in your account's Project Settings. |
| Request ID | This is a webhook sendout request ID. |
| Source ID | This is a webhook source ID. |
| Creation date | Find webhooks within a specific creation timeframe. Define the time boundaries using available date limits. |
| Sendout date | Find webhooks within a specific creation timeframe. Define the time boundaries using available date limits. |
Log filters
You can narrow down the list of logs based on:
| Filter | Definition |
| Request origin | Request origin defines how the API was called. You can filter out calls invoked by:
|
| Request result | The request log status lets you filter out successful or failed API requests.
|
| Request date | Find logs within a specific timeframe. Define the time boundaries using before and/or after date limits. |
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, confirm with the plus, and click Apply.
You can define many different filters in a single query. When filtering criteria are ready, confirm with Apply to view matching logs.
