Menu

Expand
Rate this page:

Settings - Tracking

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.

Retrieve Tracking Settings

GET /v3/tracking_settings

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve a list of all tracking settings on your account.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

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.

default: None

Responses

object
result
array[object]

The list of all tracking settings.

name
string

The name of the event being tracked.

title
string

The title of the tracking setting.

description
string

A description about the event that is being tracked.

enabled
boolean

Indicates if this tracking setting is currently enabled.

Loading Code Sample...
        
        

        Retrieve Tracking Settings

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif