Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.

Commit 94e7e7d

Browse files
authored
Merge pull request #1955 from sendgrid/open_tracking_tag
Open Tracking Pixel Substitution Tag
2 parents 4ee56cc + ae46232 commit 94e7e7d

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

source/API_Reference/Web_API_v3/Settings/tracking.apiblueprint

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,15 @@ FORMAT: 1A
128128

129129
### Update Open Tracking Settings [PATCH]
130130

131+
<p>
132+
By default, the open tracking image used to determine when an email is opened is inserted at the end of your email. It is possible to specify an alternative location by using a replacement tag and the open tracking <a href="{{root_url}}/API_Reference/SMTP_API/apps.html#opentrack">SMTP API header</a>.
133+
</p>
134+
135+
<p>
136+
If you are sending through the <a href="{{root_url}}/API_Reference/Web_API_v3/Mail/index.html">v3 Mail Send endpoint</a> then you can specify the substitution tag you want to use by setting the <code>enable</code> parameter to <code>true</code> within the <code>open_tracking</code> object and specifying the text you would like to use in the <code>substitution_tag</code> parameter. SendGrid will replace your <code>substitution_tag</code> text with the open tracking pixel wherever you insert it in your email.
137+
</p>
138+
139+
131140
+ Request (application/json)
132141

133142
+ Body

source/User_Guide/Settings/tracking.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Open Tracking
5454
If you are using email link whitelabeling, then your open tracking image will be served from your whitelabel domain instead of from SendGrid.net.
5555
{% endinfo %}
5656

57-
Open Tracking adds an invisible image at the end of the email which can track email [opens]({{root_url}}/Glossary/opens.html). If the email recipient has images enabled on their email client, a request to SendGrid’s server for the invisible image is executed and an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook.
57+
Open Tracking adds an invisible, one pixel image at the end of the email which can track email [opens]({{root_url}}/Glossary/opens.html). If the email recipient has images enabled on their email client and a request to SendGrid’s server for the invisible image is executed, then an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook.
5858

5959
When using this service customers often ask the difference between a unique open versus an open. A unique open is logged only the first time a given recipient opens the email whereas normal opens are logged for all opens of the email in question.
6060

@@ -64,6 +64,10 @@ Settings
6464

6565
**Status** - On or Off
6666

67+
**Replacement Tag** - If you do not want the open tracking image to be inserted at the end of your email, it is possible to specify an alternative location by using a replacement tag and the open tracking [SMTP API header]({{root_url}}/API_Reference/SMTP_API/apps.html#opentrack).
68+
69+
If you are sending email through our [v3 Web API]({{root_url}}/API_Reference/Web_API_v3/Mail/index.html), you may also enable the `open_tracking` parameter, and set the `substitution_tag` parameter to a value of your choice. You may insert that substitution tag anywhere in your email, and it will be replaced with the open tracking image.
70+
6771
**Related Information** - [How Google’s Image Caching effects your opens]({{site.blog_url}}/googles-new-image-caching-5-things-need-know/)
6872

6973
{% anchor h2 %}

0 commit comments

Comments
 (0)