Skip to content
Merged
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
44 changes: 24 additions & 20 deletions src/connections/sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ analytics.identify('user_123', {
{% endcodeexample %}
{% endcomment %}

> info "If you don't see the source you're looking for in our catalog"
> If a tool is not listed as a supported source in Segment's [catalog](https://segment.com/catalog/){:target='_blank’}, then it is not possible to incorporate the integration out-of-the-box within a Segment workspace. However, as an alternative, you can use the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source to collect data from the tool's API. You can also use [Functions](/docs/connections/functions/) to send or receive data from other tools.
> info "If you don't see the source you're looking for in the catalog"
> If a tool isn't listed as a supported source in Segment's [catalog](https://segment.com/catalog/){:target='_blank’}, it's not possible to incorporate the integration out-of-the-box within a Segment workspace. As an alternative, you can use the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source to collect data from the tool's API. You can also use [Functions](/docs/connections/functions/) to send or receive data from other tools.

## Types of sources

Expand All @@ -75,11 +75,16 @@ Web, Mobile, and Server sources send first-party data from your digital properti


## Event streams sources
Event streams sources collect data from your website or app to monitor user actions. These sources include [website libraries](#website-libraries), [mobile](#mobile), and [server sources](#server).
Event streams sources collect data from your website or app to monitor user actions. These sources include [website libraries](#website-libraries), [mobile](#mobile) and [server sources](#server).

### Source Overview

The Source Overview page for an event stream source shows you a [pipeline view](#pipeline-view) of all events Segment receives from your source, events that failed on ingest, events that are filtered at the source level, and "eligible events", which are the events that will flow into your destinations. If you select one of the steps in the pipeline view, you can see a line chart that reflects the fluctuations in volume alongside a [breakdown table](#breakdown-table) that has more details about the events impacted by the selected step.
The Source Overview page for an event stream source shows you:
* A [pipeline view](#pipeline-view) of all events Segment receives from your source,
* Events that failed on ingest,
* Events that are filtered at the source level,
* "Eligible events", which are the events that will flow into your destinations.
If you select one of the steps in the pipeline view, you can see a line chart that reflects the fluctuations in volume alongside a [breakdown table](#breakdown-table) that has more details about the events impacted by the selected step.

#### Pipeline view

Expand All @@ -97,10 +102,10 @@ The pipeline view shows each of the four steps Segment encounters when processin

#### Breakdown table

The breakdown table displays three tabs, **Event type**, **Event name**, and **App version**.
* **Event type**: The Segment Spec event type (Track call vs. Identify call, for example). _This tab also contains a "% change" metric, which displays how the event counts differ from the last comparable time range, represented as a percentage._
The breakdown table displays these 3 tabs:
* **Event type**: The Segment Spec event type (for example, Track call vs. Identify call). _This tab also contains a "% change" metric, which displays how the event counts differ from the last comparable time range, represented as a percentage._
* **Event name**: The event name, provided by you or the source.
* **App version**: The app/release version, provided by you or the source.
* **App version**: The app or release version, provided by you or the source.

Each of these tabs displays an event count, which is the total number of events that Segment received in a particular step.

Expand All @@ -115,7 +120,7 @@ Each of these tabs displays an event count, which is the total number of events
href="https://segment.com/academy/intro/"
icon="symbols/squares-arrow.svg"
title="The Analytics Quickstart Guide"
description="Analytics and data collection is a very broad topic and it can be quite overwhelming. How do you get started?"
description="Get started with analytics and data collection."
%}

### Mobile
Expand Down Expand Up @@ -152,7 +157,7 @@ Segment's server-side sources let you send analytics data directly from your ser

## Cloud app sources

Cloud app sources empower you to pull together data from all of your different third-party tools into a Segment warehouse or to your other enabled integrated tools. They send data about your users from your connected web apps. There are two types of Cloud Apps: [Object cloud sources](#object-cloud-sources) and [Event cloud sources](#event-cloud-sources).
Cloud app sources empower you to pull together data from all of your different third-party tools into a Segment warehouse or to your other enabled integrated tools. They send data about your users from your connected web apps. There are 2 types of Cloud Apps: [Object cloud sources](#object-cloud-sources) and [Event cloud sources](#event-cloud-sources).

{% include components/reference-button.html href="/docs/connections/sources/sources-compare/" icon="guides.svg" title="Comparing Cloud Sources" description="Wondering which cloud-apps send which types of data? Check out the Cloud Sources comparison." %}

Expand Down Expand Up @@ -189,8 +194,8 @@ Segment's [Pixel Tracking API](/docs/connections/sources/catalog/libraries/serve
| Email Opened | The recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event. |
| Email Link Clicked | The recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event. |
| Email Bounced | The receiving server could not or would not accept message. |
| Email Marked as Spam | The recipient marked message as spam. |
| Unsubscribe | The recipient clicked on message's subscription management link. |
| Email Marked as Spam | The recipient marked the message as spam. |
| Unsubscribe | The recipient clicked on the message's subscription management link. |

## Reverse ETL sources
Reverse ETL sources are data warehouses that enable you to use [Reverse ETL](/docs/connections/reverse-etl) to send data from your warehouse source to your destinations.
Expand All @@ -207,12 +212,12 @@ Segment is actively working on adding more sources. If you'd like to request Seg
## Create a source
To create a source:
1. Navigate to **Connections** and click **Add Source**.
2. Click the Source you’d like to add. *Note:* More than 80% of workspaces start by adding their JavaScript website.
2. Click the Source you’d like to add. **Note**: More than 80% of workspaces start by adding their JavaScript website.
3. Click **Add Source**.
4. Enter a name for your source as well as any information on the setup page.
5. Click **Add Source**.

Once you've created a source, the source is automatically enabled and can immediately receive events. You can review your new events in that source's [Debugger](/docs/connections/sources/debugger/) tab.
Once you've created a source, the source is automatically activated and can immediately receive events. You can review your new events in that source's [Debugger](/docs/connections/sources/debugger/) tab.


> warning "Sources not connected to an enabled destination are disabled after 14 days"
Expand All @@ -221,16 +226,15 @@ Once you've created a source, the source is automatically enabled and can immedi
> Workspace members receive an email notification before Segment disables your source so that your team has time to take action.
> If you would like to prevent this behavior in your workspace, fill out [this Airtable form](https://airtable.com/appADTobzkv0FYLbi/shr7V9LFDZh31cYWW).

> info "One source or multiple sources?"
> Segment suggests that you create one source for each type of data you want to collect. For example, you might have one source for all of your website tracking and a different source for any mobile tracking. Creating one source per data type provides the following benefits:
> - Debugger ease of use - mixing libraries/sources on a single API key means you’re heavily reliant on filtering to actually test events
> - Flexibility sending data to different projects - if you want to have different warehouse schemas, analytics projects, etc, having multiple sources would create this separation
> - More control - as your account grows with the number of destinations you enable, having separate sources allows you to have more control
> - A source type cannot be changed after it is created. You must create a new source if you would like to use a different source type.
Segment suggests that you create one source for each type of data you want to collect. For example, you might have one source for all of your website tracking and a different source for any mobile tracking. Creating one source per data type provides the following benefits:
- Debugger ease of use - mixing libraries or sources on a single API key means you’re heavily reliant on filtering to actually test events
- Flexibility sending data to different projects - if you want to have different warehouse schemas, analytics projects, having multiple sources creates this separation
- More control - as your account grows with the number of destinations you enable, having separate sources allows you to have more control
- A source type can't be changed after it is created. You must create a new source if you would like to use a different source type.

## Library tiers

Segment has defined three tiers for libraries: Flagship, Maintenance, and Community. These tiers indicate the level of support, enhancements, and maintenance each library receives from Segment.
Segment defined 3 tiers for libraries: Flagship, Maintenance, and Community. These tiers indicate the level of support, enhancements, and maintenance each library receives from Segment.

The criteria for assigning a library to a tier include its overall usage by customers and the availability of newer versions. Here's how Segment defines each tier:

Expand Down
Loading