You can track many of your recipients' interactions with your emails, including:
For more information about tracking, please see our Tracking Settings documentation.
This endpoint allows you to update your current setting for Google Analytics.
Google Analytics helps you understand how users got to your site and what they're doing there. For more information about using Google Analytics, please refer to Google’s URL Builder and their article on "Best Practices for Campaign Building".
We default the settings to Google’s recommendations. For more information, see Google Analytics Demystified.
Bearer <<YOUR_API_KEY_HERE>>Optional
The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
application/jsonOptional
Indicates if Google Analytics is enabled.
Optional
The name of the campaign.
Optional
Used to differentiate ads
Optional
Name of the marketing medium (e.g. "Email").
Optional
Name of the referrer source.
Optional
Any paid keywords.
Optional
Indicates if Google Analytics is enabled.
Optional
The name of the campaign.
Optional
Used to differentiate ads
Optional
Name of the marketing medium (e.g. "Email").
Optional
Name of the referrer source.
Optional
Any paid keywords.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5enabled: true,6utm_source: "sendgrid.com",7utm_medium: "email",8utm_term: "",9utm_content: "",10utm_campaign: "website",11};1213const request = {14url: `/v3/tracking_settings/google_analytics`,15method: "PATCH",16body: data,17};1819client20.request(request)21.then(([response, body]) => {22console.log(response.statusCode);23console.log(response.body);24})25.catch((error) => {26console.error(error);27});