# 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](/docs/sendgrid/ui/account-and-settings/tracking/).

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/tracking_settings/google_analytics","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"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](https://support.google.com/analytics/answer/1033867?hl=en) and their article on ["Best Practices for Campaign Building"](https://support.google.com/analytics/answer/1037445).

We default the settings to Google’s recommendations. For more information, see [Google Analytics Demystified](/docs/sendgrid/ui/analytics-and-reporting/google-analytics/).

## Operation details

### Authentication

API Key

### Headers

```json
[{"in":"header","name":"Authorization","required":true,"default":"Bearer <<YOUR_API_KEY_HERE>>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"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**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}]
```

### Request body

```json
{"schema":{"title":"Settings: Google Analytics","type":"object","example":{"enabled":true,"utm_source":"sendgrid.com","utm_medium":"email","utm_term":"","utm_content":"","utm_campaign":"website"},"refName":"GoogleAnalyticsSettings","modelName":"GoogleAnalyticsSettings","properties":{"enabled":{"type":"boolean","description":"Indicates if Google Analytics is enabled."},"utm_campaign":{"type":"string","description":"The name of the campaign."},"utm_content":{"type":"string","description":"Used to differentiate ads"},"utm_medium":{"type":"string","description":"Name of the marketing medium (e.g. \"Email\")."},"utm_source":{"type":"string","description":"Name of the referrer source. "},"utm_term":{"type":"string","description":"Any paid keywords."}}},"encodingType":"application/json"}
```

### Responses

```json
[{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"Settings: Google Analytics","type":"object","example":{"enabled":true,"utm_source":"sendgrid.com","utm_medium":"email","utm_term":"","utm_content":"","utm_campaign":"website"},"refName":"GoogleAnalyticsSettings","modelName":"GoogleAnalyticsSettings","properties":{"enabled":{"type":"boolean","description":"Indicates if Google Analytics is enabled."},"utm_campaign":{"type":"string","description":"The name of the campaign."},"utm_content":{"type":"string","description":"Used to differentiate ads"},"utm_medium":{"type":"string","description":"Name of the marketing medium (e.g. \"Email\")."},"utm_source":{"type":"string","description":"Name of the referrer source. "},"utm_term":{"type":"string","description":"Any paid keywords."}}},"examples":{"response":{"value":{"enabled":true,"utm_campaign":"","utm_content":"lotsandlotsofcontent","utm_medium":"","utm_source":"","utm_term":""}}}}}}}]
```

Update Google Analytics Settings

```js
const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const data = {
  enabled: true,
  utm_source: "sendgrid.com",
  utm_medium: "email",
  utm_term: "",
  utm_content: "",
  utm_campaign: "website",
};

const request = {
  url: `/v3/tracking_settings/google_analytics`,
  method: "PATCH",
  body: data,
};

client
  .request(request)
  .then(([response, body]) => {
    console.log(response.statusCode);
    console.log(response.body);
  })
  .catch((error) => {
    console.error(error);
  });
```

```python
import os
from sendgrid import SendGridAPIClient


sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY"))

data = {
    "enabled": True,
    "utm_source": "sendgrid.com",
    "utm_medium": "email",
    "utm_term": "",
    "utm_content": "",
    "utm_campaign": "website",
}

response = sg.client.tracking_settings.google_analytics.patch(request_body=data)

print(response.status_code)
print(response.body)
print(response.headers)
```

```csharp
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SendGrid;

public class Program {
    public static async Task Main() {
        string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
        var client = new SendGridClient(apiKey);

        var data =
            @"{
            ""enabled"": true,
            ""utm_source"": ""sendgrid.com"",
            ""utm_medium"": ""email"",
            ""utm_term"": """",
            ""utm_content"": """",
            ""utm_campaign"": ""website""
        }";

        var response = await client.RequestAsync(
            method: SendGridClient.Method.PATCH,
            urlPath: "tracking_settings/google_analytics",
            requestBody: data);

        Console.WriteLine(response.StatusCode);
        Console.WriteLine(response.Body.ReadAsStringAsync().Result);
        Console.WriteLine(response.Headers.ToString());
    }
}
```

```java
import com.sendgrid.*;
import java.io.IOException;
import org.json.JSONObject;
import java.util.HashMap;

public class Example {
    public static void main(String[] args) throws IOException {
        try {
            SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
            Request request = new Request();
            request.setMethod(Method.PATCH);
            request.setEndpoint("/tracking_settings/google_analytics");
            request.setBody(new JSONObject(new HashMap<String, Object>() {
                {
                    put("enabled", true);
                    put("utm_source", "sendgrid.com");
                    put("utm_medium", "email");
                    put("utm_term", "");
                    put("utm_content", "");
                    put("utm_campaign", "website");
                }
            }).toString());
            Response response = sg.api(request);
            System.out.println(response.getStatusCode());
            System.out.println(response.getBody());
            System.out.println(response.getHeaders());
        } catch (IOException ex) {
            throw ex;
        }
    }
}
```

```go
package main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"os"
)

func main() {
	apiKey := os.Getenv("SENDGRID_API_KEY")
	host := "https://api.sendgrid.com"
	request := sendgrid.GetRequest(apiKey, "/v3/tracking_settings/google_analytics", host)
	request.Method = "PATCH"
	request.Body = []byte(`{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}`)
	response, err := sendgrid.API(request)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}
```

```php
<?php
// Uncomment the next line if you're using a dependency loader (such as Composer) (recommended)
// require 'vendor/autoload.php';

// Uncomment next line if you're not using a dependency loader (such as Composer)
// require_once '<PATH TO>/sendgrid-php.php';

$apiKey = getenv("SENDGRID_API_KEY");
$sg = new \SendGrid($apiKey);
$request_body = json_decode('{
    "enabled": true,
    "utm_source": "sendgrid.com",
    "utm_medium": "email",
    "utm_term": "",
    "utm_content": "",
    "utm_campaign": "website"
}');

try {
    $response = $sg->client
        ->tracking_settings()
        ->google_analytics()
        ->patch($request_body);
    print $response->statusCode() . "\n";
    print_r($response->headers());
    print $response->body() . "\n";
} catch (Exception $ex) {
    echo "Caught exception: " . $ex->getMessage();
}
```

```ruby
require 'sendgrid-ruby'
include SendGrid

sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
data = JSON.parse('{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}')

response = sg.client.tracking_settings.google_analytics.patch(request_body: data)
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -X PATCH "https://api.sendgrid.com/v3/tracking_settings/google_analytics" \
--header "Authorization: Bearer $SENDGRID_API_KEY" \
--header "Content-Type: application/json" \
--data '{"enabled": true, "utm_source": "sendgrid.com", "utm_medium": "email", "utm_term": "", "utm_content": "", "utm_campaign": "website"}'
```