Skip to content

add footer to some of the todo list, move warehouse docs as I find them #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ defaults:
layout: "page"
hidden: false
beta: false
seo-priority: 0.5
seo-changefreq: weekly
- scope:
path: "connections/destinations"
values:
Expand Down
74 changes: 31 additions & 43 deletions _data/sidenav/default.yml
Original file line number Diff line number Diff line change
@@ -1,48 +1,5 @@
---
sections:
- section_title: Connections
section:
- path: "/connections/spec"
title: Spec
- section_title: Sources
slug: connections/Sources
section:
- path: "/connections/sources"
title: Overview
- path: "/connections/sources/visual-tagger"
title: "Visual tagger"
- path: "connections/sources/faq"
title: "FAQ"
- path: "/connections/sources/catalog"
title: Sources catalog
- section_title: Destinations
slug: connections/destinations
section:
- path: "/connections/destinations"
title: Overview
- path: "/connections/destinations/destination-filters"
title: Destinations Filters
- path: "/connections/destinations/catalog"
title: Destinations catalog
- section_title: Warehouses
slug: connections/warehouses
section:
- path: "/connections/warehouses"
title: Overview
- path: "/connections/warehouses/choose-warehouse"
title: Choosing a Warehouse
- path: "/connections/warehouses/add-warehouse-users"
title: Add users to a Warehouse
- path: "/connections/warehouses/redshift-faq"
title: "Redshift Best Practices"
- path: "/connections/warehouses/redshift-tuning"
title: "Improving Redshift performance"
- path: "/connections/warehouses/warehouse-errors"
title: "Warehouse Error codes"
- path: "/connections/warehouses/faq"
title: Warehouses FAQs
- path: "/connections/warehouses/catalog"
title: Warehouses Catalog
- section_title: Guides
section:
- path: "/guides"
Expand Down Expand Up @@ -174,6 +131,37 @@ sections:
title: How do I find out my usage data?
- path: "/guides/usage-and-billing/volume-and-pricing"
title: How does my event and object volume impact my pricing?
- section_title: Connections
section:
- path: "/connections/spec"
title: Spec
- section_title: Sources
slug: connections/Sources
section:
- path: "/connections/sources"
title: Overview
- path: "/connections/sources/visual-tagger"
title: "Visual tagger"
- path: "/connections/sources/faq"
title: "FAQ"
- path: "/connections/sources/catalog"
title: Sources catalog
- section_title: Destinations
slug: connections/destinations
section:
- path: "/connections/destinations"
title: Overview
- path: "/connections/destinations/destination-filters"
title: Destinations Filters
- path: "/connections/destinations/catalog"
title: Destinations catalog
- section_title: Warehouses
slug: connections/warehouses
section:
- path: "/connections/warehouses"
title: Overview
- path: "/connections/warehouses/catalog"
title: Warehouses catalog
- section_title: Personas
section:
- path: "/personas"
Expand Down
3 changes: 3 additions & 0 deletions connections/destinations/catalog/aboardly/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ When you `identify` a user, we'll pass that user's information to Aboardly with
## Track

When you `track` an event, we will send that event to Aboardly as a custom event.


{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/adtriba/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@ analytics.track('Conversion', {
Track calls will be sent to Adtriba as a `track` event.

Trigger additional events by using [Semantic Events](https://segment.com/docs/spec/semantic/) in order to enrich the Adtriba machine learning process.

{% include content/integration-foot.md %}
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ We attempt to match users in your audience with the identifiers that Google supp
### What Adwords platforms are supported?

This destination supports Search, Gmail, and Youtube ad campaigns. Adwords does not support Display campaigns through remarketing lists.

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/adwords/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,6 @@ The following properties are optional, if you'd like to see more, please get in
</table>

Here's Google documentation for the endpoint we hit [for iOS apps](https://developers.google.com/app-conversion-tracking/ios/conversion-tracking-server#reporting_in-app_conversions_from_an_analytics_server) and [for Android Apps](https://developers.google.com/app-conversion-tracking/android/conversion-tracking-server#in-app_conversions). It can take 24-48 hours for conversions to show up in the conversions dashboard.


{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/akita/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,6 @@ When you call `page`, Segment will send that event to Akita as a `Page View`.
## Track

When you call `track`, Segment will send that event to Akita as an `Event`.


{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/all-aboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ Segment allows you to expose what your users do in your application. This inform
For instance, using our simple example above perhaps you only want to invite customers who completed the registration process to an onboarding call. The `finished_registration: TRUE` trait allows you to quickly identify these customers.

Traits are also useful in helping you have a more personal dialog with your trial customers. More personal call invitations encourage your most qualified customers to schedule a call with you.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/appcues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,5 @@ lifecycle events that can be tracked:

To enable this feature, go to the Integrations Settings in Appcues and
click “Activate” under the Segment integration.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/apteligent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ Apteligent can show you information about the user using your app. You can recor
When an error occurs, you'll want to know what user actions led to the crash. Apteligent allows you to leave "breadcrumbs" for this purpose.

Whenever you call [`track`](/docs/spec/track/), we'll leave a breadcrumb in Apteligent. `Track` takes the name of the event and any optional `properties` you want to associate with the event.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/batch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,5 @@ All of our supported Segment integration features will work automatically, with
Batch's other features are available directly by using the native SDK, which comes bundled with this integration.

To leverage the native SDK through Segment, follow the instructions outlined [here for Android](https://segment.com/docs/sources/mobile/android/#how-can-i-use-an-destination-specific-feature-e-g-mixpanel-s-push-notifications-) and [here for iOS](https://segment.com/docs/sources/mobile/ios/#what-if-your-sdk-doesn-t-support-feature-x-).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/boomtrain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ The App ID for your app can be taken from the destination guide provided by Boom


If you have any questions, or suggestions on we can improve this documentation, feel free to [contact us](http://boomtrain.com/contact/).

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/branch-metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -837,3 +837,6 @@ LinkProperties linkProperties = new LinkProperties()
You can also control it for individual marketing links by inserting the keys and values into the deep link data section.

![image alt text](images/image_0.png)


{% include content/integration-foot.md %}
1 change: 1 addition & 0 deletions connections/destinations/catalog/bronto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ analytics.track('Order Completed', {
orderId: '55c497bf'
});
```
{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/bugsnag/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ Bugsnag will show you the `userId` and `traits` in the Users tab of each error.
## Error Reporting

In addition to sending Bugsnag user-specific information, you can send handled exceptions and diagnostic data to your Bugsnag dashboard using Bugsnag's native methods. Documentation on these methods is available [on their website](https://docs.bugsnag.com/platforms/browsers/#reporting-handled-exceptions).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/callexa/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ __If you have any questions feel free to contact Callexa at:__ [[email protected]

---
_Net Promoter, Net Promoter Score, and NPS are trademarks of Satmetrix Systems, Inc., Bain & Company, Inc., and Fred Reichheld.

{% include content/integration-foot.md %}
4 changes: 3 additions & 1 deletion connections/destinations/catalog/castle/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Castle
title: Castle
---

# Integrating through Segment
Expand Down Expand Up @@ -197,3 +197,5 @@ end
Castle's adaptive authentication tells you whether to allow access, initiate a second factor of authentication, or log out the user.

Since all Segment calls are called asynchronously, you will need to use Castle's native SDKs to perform [adaptive authentication](https://castle.io/docs/authentication).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/chameleon/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ Product tours should lead to user actions and so offer the option of tagging eac

## Help
For more information, please refer to [Chameleon's docs](https://docs.trychameleon.com) or [email them](mailto:[email protected]).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/chartbeat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ Chartbeat is only supported on the client-side.
The [`page`](/docs/spec/page/) method in Analytics.js will call Chartbeat’s `virtualPage` function with either the Url you provide or the current window’s pathname. Use the [`page`](/docs/spec/page/) method if you have a one-page app that doesn’t reload the browser page between views.

You can also set a section and author for each page. For example, `analytics.page('putSectionHere', 'putNameOfPageHere', { author: 'putAuthorNameHere' }`.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/clevertap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,5 @@ CleverTap has created a sample iOS application that integrates CleverTap via Seg
If you chose not to bundle the CleverTap Mobile SDK, then you will have to implement your own Push Message processors (and you won’t have access to CleverTap’s In-App feature).

If you decide to implement your own Push Message processors, then you can pass push tokens to CleverTap via the server-side destination. You can do this by sending it inside context.device.token.

{% include content/integration-foot.md %}
4 changes: 3 additions & 1 deletion connections/destinations/catalog/clientsuccess/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ClientSuccess
title: ClientSuccess
---
This destination is maintained by ClientSuccess.

Expand Down Expand Up @@ -44,3 +44,5 @@ When you track a `page` event, Segment will send that event to ClientSuccess as
## Group

When you call `group`, Segment will send that group's information to ClientSuccess with `groupId` as the id and `name` as the group name. Both `groupId` and `name` are required for ClientSuccess.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/comscore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,5 @@ The comScore SDK will collect unique device id's under the hood, so based on thi

### How does comScore determine the application name?
Used in the classification from comScore’s Audience reporting, comScore retrieves the application name from your app’s Info.plist application bundle name as returned by `CFBundleName`. If you want to override the automatically retrieved value, you can provide a string with your preferred app name.

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/convertro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,6 @@ When you call `.track()`, we will send that event to Convertro by setting the `e
## Application Installed

We will send this automatically collected [`Application Installed` event](/docs/spec/mobile/) to Convertro's `Installs` endpoint.


{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/cordialio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,5 @@ Update your Cordial/Segment field mapping using the same JSON format as in the P

### GET https://admin.cordial.io/api/integrations
Retrieve a JSON list of integrations you have set up with Cordial.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/countly/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ All you have to do is make a [`track`](/docs/spec/track/) call to send a custom
### Revenue

It's easy to track revenue in Countly through Segment. All you have to do is use our [`track`](/docs/spec/track/) method with a property labeled `revenue`. The value must be a number.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/criteo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,3 +299,5 @@ Criteo can receive dates in a specific format, in order for us to pass along dat
### Is the mobile integration bundled?

Even though we don't support integrating with Criteo via Segment from a server source, it's still not necessary for you to [bundle](https://segment.com/docs/guides/sources/bundled-SDK-vs-server/) the Criteo SDK into the Segment SDK! This is because while our mobile integration with them is powered from our servers, the integration requires metadata that can only be supplied by the user's mobile device (which is collected and passed along automatically by the Segment mobile SDK).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/cubitic/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ This event must contain a revenue property that specifies the amount spent using
"version": "1.1"
}
```

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/curebit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ Our Talkable destination code is open-source on GitHub if you want to [check it
## Getting Started

All you need to turn on our Talkable destination is your Talkable Site ID. If you're not sure where to look see [this Help Page](https://curebit.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) from Talkable.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/cxense/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,5 @@ window.cX.callQueue.push(['sendEvent', 'Shared Article', {
title: 'How to View a Solar Eclipse Without Damaging Your Eyes'
}])
```

{% include content/integration-foot.md %}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DoubleClick Floodlight
---

## Getting Started

The DoubleClick Floodlight destination allows you to make calls directly to Floodlight based on your mapped events. All you have to do is drop in your **DoubleClick Advertiser ID** into your settings and map the Segment `track` events to their corresponding Floodlight tags.
Expand Down Expand Up @@ -114,3 +114,5 @@ Analytics.with(context).track("Free El", new Properties().putValue("show", "Stra
Please refrain from mapping custom variables that are PII. Please refer to the [warning](https://support.google.com/dfa/partner/answer/2548879?hl=en) by DoubleClick:

The terms of your DoubleClick contract prohibit passing any information to us that we could use or recognize as personally identifiable information (PII). If you enter certain key-values into a field in a DoubleClick product, you may see a warning that reminds you that you must not use key-values to pass data that we would recognize as PII. Key-values that trigger this warning include, for example, email and username. Note that it is okay to use these key-values if your purpose is not to collect information that DoubleClick could use or recognize as PII. (For example, email=weekly is fine, but passing a user’s email address is not.) If you do choose one of these key-values, DoubleClick may contact you in the future to confirm that you are not using them in a way that is prohibited.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/drip/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ When you call [`track`](/docs/spec/track/), we'll send the event to Drip with th
## Sending Data from Drip

Drip supports sending [email events](/docs/spec/email/) to other tools on the Segment platform. These events will be sent as `track` calls to the other destinations you've turned on.

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/eloqua/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,9 @@ analytics.track({
traits: {
name: "Segment.com",
groupId: "1234567"
}
}
})
```

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/errorception/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ Errorception is only supported on the client-side.
## Identify

This is only active if you set the `meta` setting to be true. When you call [`identify`](/docs/spec/identify/) we set Errorception's `_errs.meta` to be the `traits` you passed in.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/extole/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ When you call `identify`, we keep track of the current user and will include ide
Segment supports Extole events in our client-side library through the `track` method.

**Note:** Remember, because Extole tracks custom user data, be sure to call [`identify`](#identify) before attempting to call [`track`](#track).

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/firebase/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,5 @@ As a current user of Segment-Firebase iOS, you will be able to pull in the lates
For details on the new mapping, you can check out our documentation [here](https://segment.com/docs/destinations/firebase/#event-mappings).

Please let us know if you have any questions. We recommend upgrading as soon as possible, and please [let us know](/contact) if you have any feedback about both the Firebase iOS and Android betas.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/framed.io/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ When you `track` an event, we will send that event to Framed as a user event. Ev
- `userID` (`userID`)
- `event_name` (`event_name`)
- Any properties of the event will be passed onto Framed as custom properties of the event itself.

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/freshdesk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ Here’s an example:
"locale": "en-US"
}
}' {% endcomment %}


{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/freshsales/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,5 @@ When you call a `page` event, we send a pageview to Freshsales. You can send ext
### Custom Fields Aren’t Updating

Make sure that the traits you’re passing through match the custom field’s internal name and data type.

{% include content/integration-foot.md %}
4 changes: 3 additions & 1 deletion connections/destinations/catalog/friendbuy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Friendbuy
---

## Getting Started

Setting up Friendbuy is very simple! Just login to your Friendbuy account, go to **Integration Code** > and copy the **Site ID** above the snippet box. Then paste it into your Friendbuy Destiation setting back in the Segment UI as seen in the gif below:

![](https://i.gyazo.com/f02339b0c4d567e1413c6f3891062c98.gif)
Expand Down Expand Up @@ -107,3 +107,5 @@ Then we will iterate over each item in your `properties.products` and send the f
}
}
```

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/frontleaf/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ analytics.page('Lesson');
```

* A custom URL filter (configured for you by Frontleaf) that interprets part of the page path (and/or query parameters) as the interaction type. This option can work well for "object-verb" types of URL schemes, e.g. `/lesson/123/view` and `/lesson/456/view` both get labeled as a `/lesson/view` action (which you can then relabel in the UI). [Contact Frontleaf support](https://www.frontleaf.com/contact/) for assistance with this option.

{% include content/integration-foot.md %}
3 changes: 3 additions & 0 deletions connections/destinations/catalog/gauges/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ When you call [`page`](/docs/spec/page/), we call Gauges' `track` method with no
### My visits aren't showing up in Gauges

Gauges doesn’t record data from any browser where you’ve signed into Gauges. That way your data doesn’t get polluted by your own actions. If you want your browsing to show up in Gauges - open an incognito/private window in your browser.


{% include content/integration-foot.md %}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Google Adwords New Experience
title: Google Adwords New Experience
---


Expand Down Expand Up @@ -46,3 +46,5 @@ The only exception is that for `Order Completed` events, we will map Google's se
## Multiple AdWords Account

If you are an enterprise that uses multiple AdWords accounts (usually managed by various third party agencies) you can override the top level default Google Conversion ID at the event level by entering it into the settings.

{% include content/integration-foot.md %}
2 changes: 2 additions & 0 deletions connections/destinations/catalog/google-analytics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -903,3 +903,5 @@ Analytics.track(
Google Analytics requires the `context.app.name` passed in each call. Since the `analytics-ios` SDK pulls it in [locally](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-110725), you may see the error "`context.app.name` required" if you are not providing a `CFBundleDisplayName` within your **Info.plist** file.

To resolve this error, ensure you [provide a localized info dictionary](https://github.com/segmentio/analytics-ios/blob/760be85a5119c2e8bd31a745ce2ec30385a0ad69/Pod/Classes/Internal/SEGSegmentIntegration.m#L110) as outlined [here](https://developer.apple.com/library/ios/qa/qa1823/_index.html).

{% include content/integration-foot.md %}
Loading