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

  1. How does it work?
  2. Logs overview
  3. Background tasks overview
  4. Available Log filters
  5. How to search logs with filters?

How does it work?

You have the choice between viewing Logs and Background tasks.

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.


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.

You can also browse logs with more advanced queries created with log filters. Read more.
To view all logs in the database (those beyond the 24 hour limit), simply choose the any (OR) filter option and then click  Reload.


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  aa_0b1dbed7a64644f4b7 to display more details.

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

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: 

  • Using the Dashboard.
  • Using customer's cockpits/preference center.
  • BigCommerce integration.
  • Shopify integration.
  • ActiveCampaign integration.
  • API (directly calling API endpoints via integration or manually).

Request result

The request log status lets you filter out successful or failed API requests. 

  • Success
  • Failure
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 (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.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us