On this page

Update Google Analytics Settings

API Overview

You can track many of your recipients' interactions with your emails, including:

Opening emails
Clicking links
Subscribing to (or unsubscribing from) your emails

For more information about tracking, please see our Tracking Settings documentation.

Operation overview

PATCH/v3/tracking_settings/google_analytics

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Optional

Indicates if Google Analytics is enabled.

utm_campaignstring

Optional

The name of the campaign.

utm_contentstring

Optional

Used to differentiate ads

utm_mediumstring

Optional

Name of the marketing medium (e.g. "Email").

utm_sourcestring

Optional

Name of the referrer source.

utm_termstring

Optional

Any paid keywords.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Indicates if Google Analytics is enabled.

utm_campaignstring

The name of the campaign.

utm_contentstring

Used to differentiate ads

utm_mediumstring

Name of the marketing medium (e.g. "Email").

utm_sourcestring

Name of the referrer source.

utm_termstring

Any paid keywords.

Update Google Analytics Settings

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  enabled: true,
6  utm_source: "sendgrid.com",
7  utm_medium: "email",
8  utm_term: "",
9  utm_content: "",
10  utm_campaign: "website",
11};
12
13const request = {
14  url: `/v3/tracking_settings/google_analytics`,
15  method: "PATCH",
16  body: data,
17};
18
19client
20  .request(request)
21  .then(([response, body]) => {
22    console.log(response.statusCode);
23    console.log(response.body);
24  })
25  .catch((error) => {
26    console.error(error);
27  });