Skip to content

Commit 0f4325d

Browse files
author
markzegarelli
committed
round 2
1 parent aa58b11 commit 0f4325d

File tree

13 files changed

+28
-34
lines changed

13 files changed

+28
-34
lines changed

lychee.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ headers = []
5050
### Exclusions
5151
###
5252
# Exclude URLs from checking (supports regex)
53-
exclude = ['https://ajs.cd.segment.com/analytics.js/v1/','http://0.0.0.0:4000','https://api.segment.io/v1/', 'https://segment.com/docs/assets/docs.bundle.js','https://www.linkedin.com', 'https://segment.com/jobs/', 'https://segment.com/press/', 'https://github.com/segmentio', 'https://unpkg.com/@segment/[email protected]/standalone/consent-manager.js', '(segment.com)', '(segmentapis.com)', '(example.com)', '(schema.org)','(maxcdn)', '(your-org-name)', '(mywebsite)']
53+
exclude = ['https://segment.zendesk.com','(example-service)','(redacted)','(foo)','http://dl.bintray.com/swrve-inc/android','https://ajs.cd.segment.com/analytics.js/v1/','http://0.0.0.0:4000','https://api.segment.io/v1/', 'https://segment.com/docs/assets/docs.bundle.js','https://www.linkedin.com', 'https://segment.com/jobs/', 'https://segment.com/press/', 'https://github.com/segmentio', 'https://unpkg.com/@segment/[email protected]/standalone/consent-manager.js', '(segment.com)', '(segmentapis.com)', '(example.com)', '(schema.org)','(maxcdn)', '(your-org-name)', '(mywebsite)']
5454

5555
# Exclude URLs contained in a file from checking
5656
exclude_file = []

src/connections/destinations/catalog/adroll/index.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ rewrite: true
33
title: AdRoll Destination
44
---
55

6-
[AdRoll](https://developers.adroll.com/) is a retargeting network that allows you to show ads to visitors who've landed on your site while browsing the web. The AdRoll Destination is open-source. You can browse the code on [GitHub](https://github.com/segment-integrations/analytics.js-integration-adroll).
7-
8-
This document was last updated on January 26, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
6+
[AdRoll](https://adroll.com/) is a retargeting network that allows you to show ads to visitors who've landed on your site while browsing the web. The AdRoll Destination is open-source. You can browse the code on [GitHub](https://github.com/segment-integrations/analytics.js-integration-adroll).
97

108
## Getting Started
119

src/connections/destinations/catalog/appsflyer/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Segment will automatically trigger an `Install Attributed` event if you have **t
152152
### Server
153153
If you are tracking events server-side, AppsFlyer can still send attribution postbacks but you will need to configure this functionality in your AppsFlyer account. To enable this, navigate to your AppsFlyer app and on the sidebar of the main screen click on **Integrated Partners** and search for Segment. You will be prompted with a couple of configuration options and asked to input your Segment Write Key. Once enabled, successfully attributed app installs will begin showing up as `Install Attributed` events similar to the client side behavior documented above.
154154

155-
If you are sending in the attribution data yourself, for iOS be sure the following properties are sent in within the campaign object on the `Install Attributed` or `Application Opened` event so Appsflyer can correctly attribute it as an Apple Search Ad event. These values should be returned by the [Apple Search Ads API](https://searchads.apple.com/advanced/help/measure-results/#attribution-api):
155+
If you are sending in the attribution data yourself, for iOS be sure the following properties are sent in within the campaign object on the `Install Attributed` or `Application Opened` event so Appsflyer can correctly attribute it as an Apple Search Ad event. These values should be returned by the [Apple Search Ads API](https://searchads.apple.com/help/reporting/0028-apple-ads-attribution-api):
156156

157157
```
158158
"campaign": {

src/connections/destinations/catalog/boomtrain/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ When you enable Boomtrain in the Segment web app, your changes appear in the Seg
2323

2424
## Identify
2525

26-
When you call [`identify`](/docs/connections/spec/identify/) on analytics.js, we call `person.set` on the Boomtrain Javascript Library with the `traits` object. A `userId` must be specified. For additional details about the Boomtrain `person.set` methods see [this article](https://boomtrain.readme.io/docs/personset-attributes-callback) on the Boomtrain Developer Documentation.
26+
When you call [`identify`](/docs/connections/spec/identify/) on analytics.js, we call `person.set` on the Boomtrain Javascript Library with the `traits` object. A `userId` must be specified. For additional details about the Boomtrain `person.set` methods see [this article](https://boomtrain.readme.io/docs/set) on the Boomtrain Developer Documentation.
2727

2828
## Track
2929

30-
When you call [`track`](/docs/connections/spec/track/), we will send the `event` you specify to the `track` method on the Boomtrain Javascript library, along with the properties you provide. For additional details about the Boomtrain `track` method see [this article](https://boomtrain.readme.io/docs/track-an-activity-1) on the Boomtrain Developer Documentation.
30+
When you call [`track`](/docs/connections/spec/track/), we will send the `event` you specify to the `track` method on the Boomtrain Javascript library, along with the properties you provide.
3131

3232
## Settings
3333

src/connections/destinations/catalog/new-relic/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
rewrite: true
33
title: New Relic Destination
44
---
5-
[New Relic](https://newrelic.com/insights) enables you to better understand, using their real-time analytics, the end-to-end business impact of your software performance.
5+
[New Relic](https://newrelic.com/) enables you to better understand, using their real-time analytics, the end-to-end business impact of your software performance.
66

77
This document was last updated on August 29, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
88

src/connections/destinations/catalog/perfect-audience/index.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Perfect Audience is only supported on the client-side.
2424

2525
## Track
2626

27-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
27+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
2828

2929
```javascript
3030
analytics.track("My Custom Event", {
@@ -37,12 +37,9 @@ When you call `track` on analytics.js, we call Perfect Audience's `track` with t
3737

3838
Perfect Audience requires that you define your goals ahead of time in their interface. If that hasn't happened, then they don't track the events.
3939

40-
[Here's their video of how to set that up](http://support.perfectaudience.com/knowledgebase/articles/234037-how-to-create-and-track-conversion-goals-with-perf) - you'll need to match event names between Perfect Audience and your Segment track calls.
41-
42-
4340
### Order Completed
4441

45-
If you're using our [ecommerce spec](/docs/connections/spec/ecommerce/v2/) and passing the `Order Completed` event the `orderId` and `total` will be passsed along to Perfect Audience.
42+
If you're using our [ecommerce spec](/docs/connections/spec/ecommerce/v2/) and passing the `Order Completed` event the `orderId` and `total` will be passed along to Perfect Audience.
4643

4744
## Troubleshooting
4845

src/connections/destinations/catalog/quora-conversion-pixel/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ rewrite: true
33
title: Quora Conversion Pixel Destination
44
---
55

6-
[Quora Conversion Pixel](https://www.quora.com/business) enables you to attribute downstream user actions on your website to your ad campaigns running on Quora.com. Our client-side Destination code is open source. You can browse the code in GitHub [here](https://github.com/segment-integrations/analytics.js-integration-quora-conversion-pixel).
6+
[Quora Conversion Pixel](https://www.quora.com/business) enables you to attribute downstream user actions on your website to your ad campaigns running on Quora.com. Our client-side Destination code is open source. You can browse the code in GitHub [here](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/quora-conversion-pixel).
77

88
This document was last updated on June 15th, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact).
99

src/connections/destinations/catalog/responsys/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ _NOTE_: You can find your account's endpoint by simply going to your Oracle Resp
4343

4444
4. Enter the name of your default **Profile List** where you would like to store your `.identify()` calls. Again, this can be overriden using destination specific options on a per-call basis as seen [here](#overriding-default-folder-and-list-names).
4545

46-
5. Choose whether you'd like to set your **Default Permission Status** to be `OPTIN` or `OPTOUT`. Unless configured otherwise, the default will be `OPTOUT`. If you are unsure the implications of this settings, you can read more about it [here](https://policy3.responsys.net/permission.htm).
46+
5. Choose whether you'd like to set your **Default Permission Status** to be `OPTIN` or `OPTOUT`. Unless configured otherwise, the default will be `OPTOUT`.
4747

4848
Once you have entered these required settings, you are ready to integrate your Oracle Responsys account through the Segment platform!
4949

src/connections/destinations/catalog/richpanel/index.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ This destination is maintained by Richpanel. For any issues with the destination
1919
4. In your Richpanel account, go to Data Sources > Integrations and install the Segment Connector.
2020
5. Enter the "API Key" into your Segment Settings UI which you can find from your [Richpanel data sources](https://app.richpanel.com/connectors/my/list).
2121

22-
**NOTE**: Richpanel accepts anonymous users, or [Visitors](http://event.richpanel.com/#/customers/understanding-customers), but they will not appear in the Richpanel Customer Section UI unless the customer is first identified using an `identify` call or customer actvity through Richpanel Channels, thereby becoming a [Customer](http://event.richpanel.com/#/customers/understanding-customers).
22+
**NOTE**: Richpanel accepts anonymous users, or Visitors, but they will not appear in the Richpanel Customer Section UI unless the customer is first identified using an `identify` call or customer activity through Richpanel Channels, thereby becoming a Customer.
2323

2424
## Identify
2525

26-
If you're not familiar with the Segment Specs, take a look to understand what the [`identify` method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
26+
If you're not familiar with the Segment Specs, take a look to understand what the [`identify` method](/docs/connections/spec/identify/) does. An example call would look like:
2727

2828
```js
2929
analytics.identify('userId123', {
@@ -44,11 +44,10 @@ The basic properties to identify and create a user are:
4444

4545
`uid` is a *required* field; `email`, `firstName`, and `lastName` are optional, but highly recommended.
4646

47-
See [Richpanel's User Properties](http://event.richpanel.com/#/properties) and [Richpanel's Events](http://event.richpanel.com/#/events?id=attribute-glossary) for more details.
4847

4948
## Page
5049

51-
If you're not familiar with the Segment Specs, take a look to understand what the [`page` method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
50+
If you're not familiar with the Segment Specs, take a look to understand what the [`page` method](/docs/connections/spec/page/) does. An example call would look like:
5251

5352
```js
5453
analytics.page('Pricing', {
@@ -64,7 +63,7 @@ If no `richpanel_session_id` is supplied, Richpanel will automatically generate
6463

6564
## Track
6665

67-
If you're not familiar with the Segment Specs, take a look to understand what the [`track` method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
66+
If you're not familiar with the Segment Specs, take a look to understand what the [`track` method](/docs/connections/spec/track/) does. An example call would look like:
6867

6968
```js
7069
analytics.track('Clicked Login Button', {
@@ -74,4 +73,4 @@ analytics.track('Clicked Login Button', {
7473

7574
Track calls are sent to Richpanel as a `track` event. `track` calls can only update `email` traits, but do not create them.
7675

77-
**NOTE**: Richpanel accepts all events listed in [Segment's Specs](https://segment.com/docs/connections/spec/ecommerce/v2/). For events like Order Updated, Order Cancelled, and Order Refunded, we recommend that you pass an `order_status` property.
76+
**NOTE**: Richpanel accepts all events listed in [Segment's Specs](/docs/connections/spec/ecommerce/v2/). For events like Order Updated, Order Cancelled, and Order Refunded, we recommend that you pass an `order_status` property.

src/connections/destinations/catalog/scopeai/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ This destination is maintained by ScopeAI. For any issues with the destination,
1616
2. Search for "ScopeAI" in the Catalog, select it, and choose which of your sources to connect the destination to.
1717
3. In the Segment Settings UI under "API Key" place the Segment token that can be seen after clicking "Show Token" in the panel of the Segment integration you've created in the [ScopeAI integrations page](https://www.getscopeai.com/integrations). If you haven't yet created a Segment integration on the ScopeAI app, follow these [instructions](http://help.getscopeai.com/integrations/integrating-with-segment) to create one.
1818

19-
Data will only display when there are conversations imported into ScopeAI (these must be imported through separate integrations) that have a `userId` or `email` that match with the `userId` or `email` of Segment API calls. More information on this can be found [here](http://help.getscopeai.com/integrations/integrating-with-segment).
19+
Data will only display when there are conversations imported into ScopeAI (these must be imported through separate integrations) that have a `userId` or `email` that match with the `userId` or `email` of Segment API calls.
2020

2121

2222
## Page
2323

24-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
24+
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
2525

2626
```
2727
analytics.page()
@@ -31,12 +31,12 @@ Page calls will be sent to ScopeAI as a `pageview`.
3131

3232
You can filter by this data in ScopeAI by finding "Page View" under "User Attributes".
3333

34-
This data can be used to customize analysis on ScopeAI, information on how can be found [here](http://help.getscopeai.com/getting-started/customizing-analysis).
34+
This data can be used to customize analysis on ScopeAI.
3535

3636

3737
## Identify
3838

39-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
39+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
4040

4141
```
4242
analytics.identify('userId123', {
@@ -48,17 +48,17 @@ Identify calls will be sent to ScopeAI as an `identify` event. The `userId` will
4848

4949
ScopeAI saves all traits of an `identify` event under "User Attributes" which can be used to filter queries.
5050

51-
This data can be used to customize analysis on ScopeAI, information on how can be found [here](http://help.getscopeai.com/getting-started/customizing-analysis).
51+
This data can be used to customize analysis on ScopeAI.
5252

5353

5454
## Track
5555

56-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
56+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
5757

5858
```
5959
analytics.track('Clicked Login Button')
6060
```
6161

6262
Track calls will be sent to ScopeAI as a `track` event.
6363

64-
This data can be used to customize analysis on ScopeAI, information on how can be found [here](http://help.getscopeai.com/getting-started/customizing-analysis).
64+
This data can be used to customize analysis on ScopeAI.

src/connections/destinations/catalog/totango/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ It looks like this:
4848
analytics.page('Blog', '15,000 Ways to Increase Conversion');
4949
```
5050

51-
You can label as many categories / modules as you need, but as a best practice you'll probably want to have around 5 for a small – medium sized app to 20 for a very large web-application. Not sure which modules to use? Check out Totango's [Best Practices guide](http://help.totango.com/best-practices/preparing-an-integration-worksheet/).
51+
You can label as many categories / modules as you need, but as a best practice you'll probably want to have around 5 for a small – medium sized app to 20 for a very large web-application.
5252

5353

5454
## Identify

src/connections/destinations/catalog/tv-squared/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ rewrite: true
33
title: tvsquared Destination
44
---
55

6-
[TV Squared](https://tvsquared.com/) enables you to pull same-day TV performance analytics so you can manage TV spend, and create data-driven TV media plans based on network, days, programs, and genres. Our TV Squared Destination is open-source. You can browse the code [in GitHub](https://github.com/segment-integrations/analytics.js-integration-tvsquared).
6+
[TV Squared](https://tvsquared.com/) enables you to pull same-day TV performance analytics so you can manage TV spend, and create data-driven TV media plans based on network, days, programs, and genres. Our TV Squared Destination is open-source. You can browse the code [in GitHub](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/tvsquared).
77

88
This document was last updated on April 20th, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact/)!
99

@@ -23,7 +23,7 @@ This document was last updated on April 20th, 2018. If you notice any gaps, outd
2323

2424
## Page
2525

26-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
26+
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
2727

2828
```js
2929
analytics.page();
@@ -33,7 +33,7 @@ When you call `page` in Analytics.js, we call TV Squared's `Basic Hit Tracker`.
3333

3434
## Track
3535

36-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
36+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
3737

3838
```js
3939
analytics.track('Completed Purchase', {

src/guides/how-to-guides/join-user-profiles.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Though we wish you could use a database ID for everything, some tools force you
3131

3232
## For Segment Destination Users
3333

34-
Integrating as many tools as possible through Segment will make your joins down the road a little easier. When you use Segment to [`identify`](https://segment.com/docs/connections/spec/identify) users, we'll send the same ID and traits out to all the destinations you turn on in our interface. (More about [Segment destinations](https://segment.com/docs/connections/destinations/catalog).
34+
Integrating as many tools as possible through Segment will make your joins down the road a little easier. When you use Segment to [`identify`](/docs/connections/spec/identify) users, we'll send the same ID and traits out to all the destinations you turn on in our interface. (More about [Segment destinations](/docs/connections/destinations/catalog).
3535

3636
A few of our destination partners accept an external ID, where they will insert the same Segment user ID. Then you can join tables in one swoop. For example, Zendesk saves the Segment User ID as `external_id`, making a Segment-Zendesk join look like this:
3737

@@ -150,7 +150,7 @@ ORDERBY2desc
150150

151151
An alternative to the lookup user table in SQL would be writing a script to grab user IDs across your third-party tools and dump them into your database.
152152

153-
You'd have to ping the APIs of each tool with something like an email, and ask them toreturn the key or id for the corresponding user in their tool.
153+
You'd have to ping the APIs of each tool with something like an email, and ask them to return the key or id for the corresponding user in their tool.
154154

155155
A sample script, to run on a nightly cron job, would look something like this:
156156

0 commit comments

Comments
 (0)