Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
e16bce0
ESCSP-6065 explain user invites expire in 72 hours (#717)
lucas-mitri-messagebird Apr 21, 2023
84f306e
Update postman link (#716)
theus Apr 25, 2023
08d9fea
EA-9342 - New page for How to Use Design Tracker (#721)
May 2, 2023
cb23688
SD-3745 Import "Stats HTTP API" section (#703)
seewerah May 8, 2023
e11e12a
Momentum 4.4.1 Changelog (#691)
mdyer-sparkpost May 8, 2023
0901e9c
Includes dynamic proxy_pass definition to make NGINX refresh the DNS …
pedrovivaldi May 9, 2023
cdb82b7
EA-9349 - Analytics tracker changes (#722)
Stephen-McElroy May 11, 2023
15955fd
fix: trigger deploy (#726)
CarlosLevir May 16, 2023
01f57c5
fix: update media path (#725)
CarlosLevir May 16, 2023
025b40f
Fix/escsp 6128 fix images not showing (#727)
CarlosLevir May 16, 2023
3421f6e
Fix/escsp 6128 fix images not showing (#728)
CarlosLevir May 16, 2023
4e25bc6
EA-9357 - Fix support@emailanalyst.com email address (#724)
May 18, 2023
2c963ae
fix Sendgrid migration link (#729)
theus Jun 1, 2023
ad3d42e
SD-3921: Add SPF fix line to 4.4.1 changelog (#730)
rafaelmatsumotomb Jun 5, 2023
ff9ed3e
Update how-to-use-analytics-tracker.md (#732)
svalsdottir Jun 15, 2023
938adaf
Update how-to-use-design-tracker.md, added video (#733)
svalsdottir Jun 15, 2023
ab4382f
Update how-to-use-design-tracker.md delete FAQs (#734)
svalsdottir Jun 15, 2023
4c0e234
Fixing video link (#735)
svalsdottir Jun 16, 2023
58d377f
Fixing video link for Analytics Tracker (#736)
svalsdottir Jun 16, 2023
be6dbb6
TR-4556: Add steps to enable the Host header in support docs (#731)
josecls Jun 20, 2023
b00be71
EA-9411 - Add page on how to use account ip management (#737)
Jun 23, 2023
a5c53fd
TR-2691 Add extended error code 2007 (#738)
lucas-mitri-messagebird Jun 27, 2023
5ffe95f
TR-4557: Update Fastly HTTPS setup guide (#739)
viniciusgiles Jun 29, 2023
0179cdf
TR-4558: Update CloudFlare HTTPS setup instructions (#740)
viniciusgiles Jul 3, 2023
61f841c
TR-4556: Update Microsoft Azure setup guide (#741)
josecls Jul 6, 2023
233219f
Update Google Cloud guide on setting up ET with HTTPS (#742)
viniciusgiles Jul 10, 2023
adeebb1
ESCSP-6151 Update SSO documentation (#743)
mtgray-sp Jul 17, 2023
88ecf68
EA-9381 - Fix spelling of competitive (#744)
Jul 19, 2023
ecefff3
DT now available to all IT accounts
svalsdottir Aug 23, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/site/analystHomePageContent.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const gettingStarted = {
},
{
url: '/analyst/competitive-tracker/',
title: 'Competitve Tracker',
title: 'Competitive Tracker',
desc: 'Guides for optimizing your use of Competitive Tracker',
linkText: 'Learn More',
},
Expand Down Expand Up @@ -59,7 +59,7 @@ const help = {
</>
),
content: [
{ text: 'Submit a ticket', url: 'mailto:support@emailanalyst.com', Icon: Feedback },
{ text: 'Submit a ticket', url: 'mailto:support@edatasource.com', Icon: Feedback },
],
};

Expand Down
2 changes: 1 addition & 1 deletion components/site/analystNavigation.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const AnalystNavigation = (props: NavigationProps): JSX.Element | null => {
return (
<BaseNavigation data={data} title={title} titleLink={titleLink}>
<Box py="450" mt="450" borderTop="400">
<Link href="mailto:support@emailanalyst.com" passHref>
<Link href="mailto:support@edatasource.com" passHref>
<StyledLink>
<Box px="500">
<Feedback size={20} />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
lastUpdated: '06/22/2023'
title: 'How to Use Account IP Management'
description: 'This is an account-level setting. The platform will automatically detect your sending IPs based on the traffic from your sending domains. Those IPs will appear in the “Likely IPs” section. You may customize this by creating static groups of IPs. As you add or remove IPs from your sending infrastructure, you must make those changes in your IP groups as well.'
---


*This is an account-level setting. The platform will automatically detect your sending IPs based on the traffic from your sending domains. Those IPs will appear in the “Likely IPs” section. You may customize this by creating static groups of IPs. As you add or remove IPs from your sending infrastructure, you must make those changes in your IP groups as well.*

**Note:** You must have a Manager role to be able to access the Account IP Management page.


## Add a new IP Address to a new IP Group

Select the User Cog

Under Account Settings, select Account IP Management

![](media/how-to-use-account-ip-management/it-dropdown-menu.png)

Select New

![](media/how-to-use-account-ip-management/new-ip-group.png)

Enter the name of your new IP Group and then select Create

![](media/how-to-use-account-ip-management/create-ip-group.png)

Enter the IP Address and then select Add IP Address

![](media/how-to-use-account-ip-management/add-ip-address.png)

## Add a new IP Address to an existing IP Group

Select the User Cog

Under Account Settings, select Account IP Management

![](media/how-to-use-account-ip-management/it-dropdown-menu.png)

Select View All and then select the IP Group

![](media/how-to-use-account-ip-management/view-all-select.png)

Enter the IP Address and then select Add IP Address

![](media/how-to-use-account-ip-management/add-ip-address.png)

## Add Bulk Upload of IP Addresses

Select Select File and choose your list to upload.

![](media/how-to-use-account-ip-management/select-file.png)

The file upload only supports .txt format

The file shall only have 1 IP Address per line in the format 10.10.0.1

![](media/how-to-use-account-ip-management/process-file.png)

Select Process File

## Remove an IP Group

Select the User Cog

Under Account Settings, select Account IP Management

![](media/how-to-use-account-ip-management/it-dropdown-menu.png)

Select View All and then select the IP Group

![](media/how-to-use-account-ip-management/view-all-select.png)

Select Delete

![](media/how-to-use-account-ip-management/delete-ip-group.png)

Select Delete to confirm

![](media/how-to-use-account-ip-management/confirm-delete.png)
Original file line number Diff line number Diff line change
@@ -1,63 +1,58 @@
---
lastUpdated: "02/23/2023"
lastUpdated: "05/02/2023"
title: How to Use Analytics Tracker
description: Interested to learn more about your subscribers? Create a tracking pixel to include in your email campaigns.
---

## Place the EDS engagement pixel in the HTML of your next email campaign to find out:
## Use the tracking pixel in your next email campaign to find out:

* How much time subscribers spend reading the email
* What browser or device they open with
* Where in the world they're located when they interact with the campaign
* What browser or device are used to open the email
* What regions recipients are located in when they interact with the email

**Navigate to Analytics Tracker and select “New Tracking Code”**
Watch this short [video to learn how to use Analytics Tracker](https://www.veed.io/view/b458f788-07e1-4553-b743-2d469a356ba2?panel=share).

![](media/how_to_use_analytics_tracker/image_0.png)
## Create a new tracking code: ##

**Follow the simple steps to create the tracking code:**
### 1. Navigate to Analytics Tracker and select “New Analytics Campaign”

1. Enter a name that you will recognize and connect to the email campaign
2. Select the sending domain that you will use for the email campaign
3. Set an expiration date when we should stop collecting new engagement data for this campaign
![](media/how_to_use_analytics_tracker/newanalyticscampaign.png)

![](media/how_to_use_analytics_tracker/image_1.png)
### 2. Name Your Tracking Code

Next, select your email deployment software (If you don’t see your ESP in the list, select “Other” and input the merge tag that your provider uses to dynamically publish the recipient’s email address into your email content. Example: %%emailaddr%%)
- Enter a tracking code name
- Set an expiration date for tracking this campaign
- Click "Select your marketing software" button to proceed to the next step.

![](media/how_to_use_analytics_tracker/image_2.png)
![](media/how_to_use_analytics_tracker/trackingcode.png)

Copy the tracking code and place it into your HTML. Once added, send a preview of your email campaign to the test address shown (Pro Tip: If this isn’t your first rodeo, “Skip this” to end the tracking code setup):
### 3. Place the Tracking Code in Your Email

![](media/how_to_use_analytics_tracker/image_3.png)
- From the pulldown, select your email deployment software. If you don’t see your ESP in the list, select “Other” and input the merge tag that your provider uses to dynamically publish the recipient’s email address into your email content. Example: `%%emailaddr%%`
- Copy the tracking code, paste it into your HTML, and select Done. If you want to verify the tracking code before deployment select the "Verify Code" button.
- After you email the campaign, come back to Analytics Tracker and view the results for the campaign.

Once you’ve mailed the campaign, come back to Analytics Tracker and view the results for the campaign. Each time one of your subscriber's opens the email containing the pixel, that is one Analytics event. Data will continue to be collected until the expiration date that you defined in the tracking code setup.
![](media/how_to_use_analytics_tracker/trackingcode2.png)

## Scheduled Analytics Exports

We've made exporting Analytics campaigns a whole lot easier! You can now schedule an events export for 'daily' or 'weekly' during an active campaign, or 'upon expiration' of the campaign tracking.

Here is a look at the all the export options that are available:
*Note: Each time one of your subscriber's opens the email containing the pixel, that is one Analytics event. Data will continue to be collected until the expiration date that you defined in the tracking code setup.*

![](media/how_to_use_analytics_tracker/image_4.png)

Use your findings to prioritize optimization of your email template across email clients, browser and devices. Understand where your subscribers are located throughout the world and how much time they spend viewing your email.

![](media/how_to_use_analytics_tracker/image_5.png)
## Scheduled Analytics Exports

We've made exporting Analytics campaigns a whole lot easier! You can now schedule an events export for 'daily' or 'weekly' during an active campaign, or 'upon expiration' of the campaign tracking.

![](media/how_to_use_analytics_tracker/image_6.png)
Here are all the available export options:

![](media/how_to_use_analytics_tracker/export.png)

![](media/how_to_use_analytics_tracker/image_7.png)
Use your findings to prioritize optimization of your email template across email clients, browser and devices. Understand where your subscribers are located throughout the world and how much time they spend viewing your email.

![](media/how_to_use_analytics_tracker/counts.png)

![](media/how_to_use_analytics_tracker/image_8.png)

![](media/how_to_use_analytics_tracker/engagement.png)

![](media/how_to_use_analytics_tracker/image_9.png)

![](media/how_to_use_analytics_tracker/emailclients.png)

![](media/how_to_use_analytics_tracker/image_10.png)

![](media/how_to_use_analytics_tracker/geolocation.png)

![](media/how_to_use_analytics_tracker/image_11.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
lastUpdated: "08/23/2023"
title: How to Use Design Tracker
description: Design Tracker lets you see what your email looks like in common inboxes and devices. Use this to find rendering issues before you send your email.
---

Design Tracker lets you see what your HTML email looks like in common email clients and devices. Use these email previews to catch rendering issues before you send your campaign.

Available with all Inbox Tracker accounts. Watch this short video on [how to use Design Tracker](https://www.veed.io/view/3efe7959-d835-4a00-948c-93e4a0394871?panel=share) to test your emails.

**Note**: This feature is currently in **Beta** and available to all Inbox Tracker accounts.

## Test a new email campaign

There are two ways to test an email in Design Tracker:
- Send an email to a static email address
- Paste an email's HTML into a field and submit it

### Send an email to a static email address
- Enable your static email address.
- In the Design Tracker tab, click on the **Configure** button in the top-right corner and select **Manage static email address**.
- Click the **Enable** button in the module provided.
- Copy the static email address.
- You can now send your email to the static email address from wherever you create your campaign.

### Paste an email's HTML into a field and submit it
- In the Design Tracker tab, click the **New Email Preview Test** button in the top right corner.
- Fill in the internal **Test Name** field.
- Select the preview options you want to test your email with.
- Paste an email's HTML into the **Email HTML** field.
- Scroll down to click **Test Email Design**. You can leave the page while the test is running.

## Retest an email campaign
You can use either method of testing to retest the same email. Design Tracker will group emails based on Subject Line, so if you previously submitted your HTML directly but would now like to send to the static email, use the same Subject Line to have both test results appear in the same **Email Previews Dashboard**. You can then go between them using the drop-down menu that appears when an email has more than one test.

![Retested Email Results drop-down](media/how-to-use-design-tracker/retest-email-results-dropdown.png)

### Retest an email campaign using the static email address
- Send your updated email to your static email address.
- If the subject line remains the same, the new previews will show up in the same-named test.

### Retest an email campaign by pasting and submitting the HTML
- From the _Email Previews Dashboard_ of a tested email, click the **Retest Email** button in the top-right corner.
- Paste the email's new HTML into the HTML field.
- Scroll down to click **Submit Test**. You can leave the page while the test is running.

## Other features
- Use the _Approved / Not Approved_ buttons to indicate whether the previewed email looks good or not.
- This is an account-wide indicator. If another user looks at the _Email Preview Test Results_ after you've made a selection, they will see that selection.
- Export email test results using the **Export Results** button on the _Email Preview Test Results_ screen.
- Use the **Archive Test** button to hide tests from the _Email Previews Dashboard_. See archived tests by clicking the **Show** button next to **View Archived**, above the list of tests.
- Manage which email client/device options are used for tests made by the static email address in **Configure** >> **Manage Default Test Clients**.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions content/docs/getting-started/getting-started-sparkpost.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Here are migration guides for other popular Email Services:

## Sending Email

If you'd like to dive right in, you can read the [API reference documentation](https://developers.sparkpost.com/api/) and we have a [collection](https://www.postman.com/run-collection/81ee1dd2790d7952b76a) for [Postman](https://www.postman.com/) to help you experiment with manual API calls.
If you'd like to dive right in, you can read the [API reference documentation](https://developers.sparkpost.com/api/) and we have a [collection](https://god.postman.co/run-collection/ee44dcd644445e8bd864?action=collection%2Fimport) for [Postman](https://www.postman.com/) to help you experiment with manual API calls.

In case you need it, SparkPost also supports [SMTP-based email delivery](#header-SMTP) with a few modern twists.

Expand Down Expand Up @@ -221,7 +221,7 @@ Beyond the basics, SparkPost also has a slew of additional capabilities which ma

### Email Templates And Personalization

If you're sending similar content to lots of people, Templates let you write the message once using substitution variables and logic for personalization. You can create and edit templates on your account in the [Templates](https://app.sparkpost.com/templates) ([EU](https://app.eu.sparkpost.com/templates)) page. Check the SparkPost [template language](https://developers.sparkpost.com/api/template-language/) for information on how to personalize your emails.
If you are sending similar content to lots of people, Templates let you write the message once using substitution variables and logic for personalization. You can create and edit templates on your account in the [Templates](https://app.sparkpost.com/templates) ([EU](https://app.eu.sparkpost.com/templates)) page. Check the SparkPost [template language](https://developers.sparkpost.com/api/template-language/) for information on how to personalize your emails.

### Service Providers - Subaccounts

Expand Down
20 changes: 10 additions & 10 deletions content/docs/my-account-and-profile/sso.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
lastUpdated: "01/25/2022"
lastUpdated: "07/17/2023"
title: "Single Sign-On (SSO)"
description: "How to enable Single Sign-On (SSO) in SparkPost."
---

Single sign-on (SSO) allows you login to your account using your company's preffered identify provider. You can enable SSO through any provider that supports SAML. You can also set up [SCIM user provisioning through OKTA](https://support.sparkpost.com/docs/my-account-and-profile/scim/).
Single sign-on (SSO) allows you to login to your account using your company's preffered identify provider. You can enable SSO through any provider that supports SAML. You can also set up [SCIM user provisioning through OKTA](https://support.sparkpost.com/docs/my-account-and-profile/scim/).

Check this [article](https://support.sparkpost.com/docs/faq/difference-between-starter-and-premier/) to verify that your account's plan level supports SSO.

Expand All @@ -16,24 +16,24 @@ Enabling SSO is a 3-step process:
Go to your [Account Settings page](https://app.sparkpost.com/account/settings)([EU](https://app.eu.sparkpost.com/account/settings)) and click on "Provision SSO" to upload your SAML configuration file. Copy the callback URL to configure your identity provider.

### 2. Configure your identity provider with the callback URL:
Configure your identity provider with the callbackURL from the previous step. Refer to your identity provider documentation for instructions on where to submit this information.
Configure your identity provider with the callback URL from the previous step. Refer to your identity provider documentation for instructions on where to submit this information.

### 3. Re-invite your users:
Users have to be re-invited in order to start signing in with SSO. You can delete current users and re-invite them from the [Users](https://app.sparkpost.com/account/users)([EU](https://app.eu.sparkpost.com/account/users)) page.
Users have to be re-invited in order to start signing in with SSO. You can delete current users and re-invite them from the [Users](https://app.sparkpost.com/account/users)([EU](https://app.eu.sparkpost.com/account/users)) page.

## Disable Single Sign-On
Disabling SSO is a 2-step process:

### 1. Disable for account:
Go to your [Account Settings](https://app.sparkpost.com/account/settings)([EU](https://app.eu.sparkpost.com/account/settings)) and click on "Provision SSO" to upload your SAML configuration file. Once provisioned, you can enable SSO for the account.
Go to your [Account Settings](https://app.sparkpost.com/account/settings)([EU](https://app.eu.sparkpost.com/account/settings)) and click on "Disable SSO".

### 2. Re-invite your users:
Users have to be re-invited in order to set their passwords. You can delete current users and re-invite them from the [Users](https://app.sparkpost.com/account/users)([EU](https://app.eu.sparkpost.com/account/users)) page.
Users have to be re-invited in order to set their passwords. You can delete current users and re-invite them from the [Users](https://app.sparkpost.com/account/users)([EU](https://app.eu.sparkpost.com/account/users)) page.

## FAQ

### What do I need to provide to my idendity provider?
The specifics for configuring SSO in your idendity provider varies by provider, so we recommend you reference their documentation for full details. In general, you will need to provide the callback URL as described above. You may also be asked for metadata in some cases. If so, here is the metadata you can provide to your idendity provider:
### What do I need to provide to my identity provider?
The specifics for configuring SSO in your identity provider varies by provider, so we recommend you reference their documentation for full details. In general, you will need to provide the callback URL as described above. You may also be asked for metadata in some cases. If so, here is the metadata you can provide to your identity provider:

*Note: the entity ID for legacy SAML configurations is `passport-saml`.*

Expand Down Expand Up @@ -94,8 +94,8 @@ No, there is no default user role - role is decided by the admin user when addin
### Can the user role be changed after a SSO user has been created?
Yes, an admin user can change the user role for any user (including SSO users) at any time.

### Is there a way to bypass SSO once its enabled?
An admin can enable or disable SSO for each user at any time. However, there is no way to bypass SSO if it is enabled for a specific user - the admin must disable for that user in order to login via password.
### Is there a way to bypass SSO once it's enabled?
An admin can disable SSO by following the steps in the "Disable Single Sign-On" section above.

### Can I use both SSO and multi-factor authentication (MFA)?
No. Users can only use either MFA or SSO.
Expand Down
Loading