Bloomerang Fundraising’s Analytics API allows for seamless integration of Bloomerang Fundraising (formerly Qgiv by Bloomerang) forms with various external applications and tracking tools, such as Google Tag Manager, Google Analytics 4, Meta Pixel, and others. This allows you to monitor and analyze Bloomerang Fundraising conversion events, optimizing your fundraising efforts through effective data collection and analysis.

Pro tip: Qgiv by Bloomerang is now Bloomerang Fundraising! We're still updating things in our code base, so you'll see references to "Qgiv" and "Qgiv events" throughout this article. You're in the right place and should continue to use "Qgiv" in the code where indicated.

The API uses the dataLayer, a JavaScript object that captures and transmits information on your Bloomerang Fundraising forms. When a Bloomerang Fundraising event is triggered, the relevant data is automatically pushed to the dataLayer, making it accessible for tracking and deeper insights.

This article explains the different events and parameters that you can track using the Bloomerang Fundraising data layer.

Pro tip: Throughout this article, “events” refers to actions that can occur on a webpage, which you can track.

Please note: Analytics API is not compatible for tracking on sites built in Wix, GoDaddy Website Builder, or Google Sites. If your website is hosted by WordPress.com, you must have a plugin-enabled plan (Creator or Entrepreneur).

Check out this article to learn how to connect an analytics service to Bloomerang Fundraising via the Service Integrations landing page.

JavaScript Events

Bloomerang Fundraising creates JavaScript “events” based on the state of the Bloomerang Fundraising form. Our Bloomerang Fundraising events include the following:

Page view QGIV.pageView - Triggered when a form is loaded, when a user navigates between steps, and upon completion of a donation.
Donation started QGIV.donationStart - Triggered when a donation form is loaded.
Donation step change QGIV.donationStepChange - Triggered when a user navigates between steps in a donation form.
Donation completed QGIV.donationComplete - Triggered each time a donation is successfully completed.
Donation abandoned QGIV.donationClose - Triggered when a user exits a donation form without completing the donation process.
Registration started QGIV.registrationStart - Triggered when a registration form is loaded.
Registration step change QGIV.registrationStepChange - Triggered when a user navigates between steps in a registration form.
Registration completed QGIV.registrationComplete - Triggered each time a registration is successfully completed.
Registration abandoned QGIV.registrationClose - Triggered when a user exits a registration form without completing the registration process.
Transaction completed QGIV.ga4Purchase - Triggered when a user completes a transaction, formatted to be compatible with Google Analytics 4’s purchase event.

Events push payloads to the dataLayer on the webpage where the donation form is embedded. If the form is deployed on a Bloomerang Fundraising Landing Page, the payloads are added to that page's dataLayer. If the form is a widget on an external domain, the payloads are added to the external webpage’s dataLayer, allowing for data collection across most analytics tools added to the website.

Custom Bloomerang Fundraising Events include a payload with a structure designed by Bloomerang Fundraising, while the QGIV.ga4Purchase event adheres to the Google Analytics 4 purchase event format.

Parameters Reference

Here are the various data points that may be present when users interact with your forms. Which parameters you see will depend on the products you’re using and tracking:

Parameter	Data Type	Description
QGIV.form.id	String	The ID of the donation form.
QGIV.form.name	String	The name of the donation form.
QGIV.contact.company	String	The value that is present in the "Company" field.
QGIV.contact.email	String	The value that is present in the "Email" field.
QGIV.contact.firstName	String	The value that is present in the "First Name" field.
QGIV.contact.givenAnonymously	Boolean	The value that is present in the "Given Anonymously" field.
QGIV.contact.lastName	String	The value that is present in the "Last Name" field.
QGIV.contact.optedIn	Boolean	The value that is present in the "Opted In" field.
QGIV.customFields.Reporting_Label_1	String, Boolean or Array<String>	The value associated with a custom field. This key is only present if: The custom field is visible. The user entered data into the custom field.
QGIV.restrictions.["Restriction Name 1"].lineAmount	Number	The “Line Amount” associated with a restriction. This key is only present if the user has selected a restriction.
QGIV.restrictions.["Restriction Name 1"].subRestriction	String	The “Sub Restriction” that is associated with a restriction. This key is only present if the user has selected: A restriction A sub-restriction
QGIV.dedication.dedicationRecipientsEmail	String	The value that is present in the "Dedication Recipients Email" field. This key is only present if the user has selected a dedication and the user adds a value to the “Email” field that is part of the Dedication Notification.
QGIV.dedication.name	String	The value that is present in the "Who do you want to recognize" field that is part of the dedication. This key is only present if the user has selected a dedication.
QGIV.dedication.type	String	The value that is present in the "What type of dedication" field that is part of the dedication. This key is only present if the user has selected a dedication.
QGIV.dedication.Reporting_Label_1	String or Array<String>	The value associated with a dedication field. This key is only present if: The user has selected a dedication. The dedication field is visible. The user entered data into the dedication field.
QGIV.transaction.associatedInfo	String	The data that is associated with the “Associated Info” parameter of the transaction, if one is present.
QGIV.transaction.currency	String	The currency that is associated with the transaction. Options: "USD", "CAD"
QGIV.transaction.date	String	The date on which the transaction was completed. Format: YYYY-MM-DD HH:MM:SS
QGIV.transaction.demo	Boolean	Whether or not the transaction occurred when the form had a status of “Demo”.
QGIV.transaction.frequency	String	The “Recurring Frequency” of the donation. Options: "One Time", "Daily" , "Weekly" , "Bi-Weekly" , "Monthly" , "Quarterly", "Semi-Annually", "Annually"
QGIV.transaction.giftAssist	Number	The dollar value of the amount that is associated with Gift Assist.
QGIV.transaction.id	String	The id of the transaction.
QGIV.transaction.paymentMethod	String	The payment method that was used to complete the transaction. Options: "American Express", "Visa" , "MasterCard" , "Discover" , "MasterCard", "E-Check" , "No charge" , "Cash" , "Check", "Venmo", "PayPal", "Matching", "Bill to Carrier" , "Facebook"
QGIV.transaction.recurring	Boolean	Whether the transaction was a recurring donation.
QGIV.transaction.status	String	The status of the transaction. Options: "Accepted" , "Offline" , "Declined" , "Error", "Pending", "Promise", "Testing", "Unverified" , "Uploaded", "Verified"
QGIV.transaction.timestamp	String	The date on which the transaction was completed formatted as a Unix timestamp.
QGIV.transaction.total	Number	The total dollar value of a transaction.
QGIV.transaction.type	String	Whether the transaction was made by an individual or a company. Options: "individual" , "company"

Payload Structure

The payload for each Bloomerang Fundraising event follows this standardized structure:

{
    QGIV: {
      form: {...},
      contact: {} || {...},
      customFields: {} || {...},
      dedication: {} || {...},
      restrictions: {} || {...},
      transaction: {} || {...},
      utm: {},
    }
}

Here’s a breakdown of each key and whether or not you should expect an empty object {} or an object with data inside of it {...}:

form: This object always contains keys for all of the events.
contact: This object always contains keys for all of the events.
customFields: This object only contains keys when a custom field has been filled out.
dedication: This object only contains keys when a donor has selected a dedication.
restrictions: This object only contains keys when a donor has selected a restriction.
transaction: This object only contains keys when a transaction has been completed.
utm: This object is always empty as it is just a placeholder object that will at some point in the future be used to collect data related to UTM tracking.

JavaScript Event System

In addition to pushing data to the dataLayer, the JavaScript event system allows you to run custom code when specific events are triggered during the donation or registration process. This system enables developers to create more dynamic integrations by responding directly to key form actions through JavaScript.

Custom Fields

You can extend Bloomerang Fundraising's event system to include custom fields, ensuring they are pushed to the dataLayer when events like donationComplete or donationStart are fired.

Here’s an example of how you might set up some custom code for events on your forms:

QGIV.on('donationComplete', function(details) {
  var transid = QGIV.transaction.id;
  var amount = QGIV.transaction.total;
  var frequency = QGIV.transaction.frequency;
  // Push custom fields to data layer
  dataLayer.push({
    'event': 'donationComplete',
    'transid': transactionid,
    'amount': amount,
    'frequency': frequency
  });
});

Testing Custom Events

Use your browser’s console to test and ensure that the custom fields are being tracked and pushed to the dataLayer correctly. This is helpful for troubleshooting.

Here’s an example of how you might set up some custom code for events:

QGIV.on('donationComplete', function(details) {
  console.log('Donation Complete!');
  console.log('Donation Details:', details);
  // Add your custom code here
});