Skip to content

Segu Links #618

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 3 commits into from
Feb 11, 2020
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
4 changes: 3 additions & 1 deletion src/connections/spec/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: 'Spec: Alias'
---

> note "Alias is an advanced method"
> The Alias method allows you to explicitly change the ID of a tracked user, however this should only be done when it's required for downstream destination compatibility. See our [Best Practices for Identifying Users](/docs/guides/how-to-guides/best-practices-identify/) for more information.
> The Alias method allows you to explicitly change the ID of a tracked user, however this should only be done when it's required for downstream destination compatibility. See our [Best Practices for Identifying Users](/docs/guides/how-to-guides/best-practices-identify/) for more information.

The `alias` method is used to merge two user identities, effectively connecting two sets of user data as one. This is an advanced method, but it is required to manage user identities successfully in some of our destinations.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/324252?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Segment Methods" content="Check out our high-level overview of these APIs in Segment University. (Must be logged in to access.)" %}

Since this is our most advanced method we have added sections to each docs page for destinations that use it:

- [KISSmetrics](/docs/connections/destinations/catalog/kissmetrics#alias)
Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ In the Segment [Spec](/docs/connections/spec/) all the [API calls](/docs/connect

However, not all destinations accept all fields included in the Spec. Not sure which fields a destination accepts? Refer to the destination's documentation page, or check out the [open-source destination code on Github](https://github.com/segment-integrations).

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/324252?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Segment Methods" content="Check out our high-level overview of these APIs in Segment University. (Must be logged in to access.)" %}

## Structure
Every API call has the same core structure and fields. These fields describe user identity, timestamping and mechanical aides like API version.

Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: 'Spec: Group'

The `group` API call is how you associate an individual user with a group—be it a company, organization, account, project, team or whatever other crazy name you came up with for the same concept!

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/324252?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Segment Methods" content="Check out our high-level overview of these APIs in Segment University. (Must be logged in to access.)" %}

A user can be in more than one group; however, not all platforms support multiple groups. It also lets you record custom traits about the group, like industry or number of employees. Calling `group` is a slightly more advanced feature, but it's helpful if you have accounts with multiple users.

Here's the payload of a typical `group` call, with most [common fields](/docs/connections/spec/common/) removed:
Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/identify.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ related:

`identify` lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them like their email, name, etc.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/299968?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Identify Method" content="Check out our high-level overview of the Identify method in Segment University. (Must be logged in to access.)" %}

Our recommendation for when and how often you should call identify is as follows:

- After a user registers
Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ redirect_from:

The Segment Spec provides guidance on meaningful data to capture, and the best format for it, across all of our libraries and APIs. If you implement Segment using these formats, it's simple to translate your data to downstream tools.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/324252?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Segment Methods" content="Check out our high-level overview of these APIs in Segment University. (Must be logged in to access.)" %}

The Segment Spec has three components.

First, it **outlines the semantic definition of the customer data we capture across all of our libraries and APIs**. There are six API calls in the Spec. They each represent a distinct type of semantic information about a customer. Every call shares the same [common fields](/docs/connections/spec/common/).
Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: 'Spec: Page'

The `page` call lets you record whenever a user sees a page of your website, along with any optional properties about the page. Calling `page` or [`screen`](/docs/connections/spec/screen/) in one of our [sources](/docs/connections/sources/) is one of the first steps to getting started with Segment.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/299969?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Page Method" content="Check out our high-level overview of the Page method in Segment University. (Must be logged in to access.)" %}

**Note:** **In `analytics.js` a `page` call is included in the snippet by default** just after `analytics.load`. We do that because you **must** call this method at least once per page load. However, you can choose to add an optional `name` or `properties` to the default call, or call it multiple times if you have a single-page application.

Here's the payload of a typical `page` call with most [common fields](/docs/connections/spec/common/) removed:
Expand Down
4 changes: 3 additions & 1 deletion src/connections/spec/screen.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: 'Spec: Screen'

The `screen` call lets you record whenever a user sees a screen, the mobile equivalent of `page`, in your mobile app, along with any properties about the screen. Calling `page` or [`screen`](/docs/connections/spec/screen/) in one of our [sources](/docs/connections/sources/) is one of the first steps to getting started with Segment.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/299973?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Screen Method" content="Check out our high-level overview of the Screen method in Segment University. (Must be logged in to access.)" %}

Here's the payload of a typical `screen` call, with most [common fields](/docs/connections/spec/common/) removed:

```js
Expand Down Expand Up @@ -89,7 +91,7 @@ Reserved properties we have standardized:
<tr>
<td>`name`</td>
<td>String</td>
<td>Name of the screen.
<td>Name of the screen.

This is reserved for future use.</td>
</tr>
Expand Down
2 changes: 2 additions & 0 deletions src/connections/spec/track.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: 'Spec: Track'

The `track` API call is how you record any actions your users perform, along with any properties that describe the action.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/299975?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: The Track Method" content="Check out our high-level overview of the Track method in Segment University. (Must be logged in to access.)" %}

Each action is known as an event. Each event has a name, like **Registered**, and properties, for example a **Registered** event might have properties like `plan` or `accountType`. Calling `track` in one of our [sources](/docs/connections/sources/) is one of the first steps to getting started with Segment.

Here's the payload of a typical `track` call with most [common fields](/docs/connections/spec/common/) removed:
Expand Down
4 changes: 4 additions & 0 deletions src/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ title: Getting Started with Segment

Welcome! This page is a high-level introduction to the Segment Platform, including what it does and how. (If you're looking for detailed information about architecture, setup, or maintenance, you can [skip ahead](#where-can-i-learn-more).)

{% include components/media-icon.html href="
https://university.segment.com/introduction-to-segment/299955?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: How Segment Works" content="Check out how Segment works in Segment University and how to get started with Segment in Segment University! (Must be logged in to access.)" %}

## What is Segment?

Segment is a Customer Data Infrastructure (CDI) service provider, which means that we provide a service that simplifies collecting and using data from the users of your digital properties (websites, apps, etc). With Segment, you can collect, transform, send, and archive your [first-party customer data](https://segment.com/books/customer-data/first-party-data/). We simplify the process of collecting data and hooking up new tools, allowing you to spend more time using your data, and less time trying to collect it.

You can also enrich the customer data you collect by connecting data from your other tools, and then aggregate it to monitor performance, inform decision-making processes, and create uniquely customized user experiences. You can also use Personas, our identity resolution tool, to unify data from individual users to gain a wholistic understanding of their actions.


## What does it do?

In its very simplest form, Segment helps you generate messages about what's happening in your site or app, then translates those messages into different formats for use by other tools (which we call '[Destinations](/docs/connections/destinations)'), and transmits messages to those tools. The Segment servers also archive a copy of the data, and can [send data to your storage systems](/docs/connections/warehouses) (such as databases, warehouses, or bulk-storage buckets).
Expand Down
2 changes: 2 additions & 0 deletions src/guides/intro-impl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Segment for Developers

This guide explains all you need to know to get started with your Segment implementation, and directs you to more resources depending on your specific needs.

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/324262?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: Segment in Action" content="See a quick example of Segment working on an ecommerce website. (Must be logged in to access.)" %}

## What does Segment do?

Segment sends messages about activities in your mobile apps, websites or servers, receives messages those messages, and translates and forwards the message contents to Destination tools. It also can send the contents of those messages to a bulk storage destination for archiving. In more complicated implementations, Segment can serve as a wrapper to trigger messages directly to other APIs, and can inspect, correct, classify and block the message contents.
Expand Down
1 change: 1 addition & 0 deletions src/segment-app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: The Segment Web App

When you first log in, you go to your workspace. (If you're a member of several workspaces, you get to choose which one to go to.) Workspaces organize sets of sources and destinations

{% include components/media-icon.html href="https://university.segment.com/introduction-to-segment/299965?reg=1&referrer=docs" icon="media/icon-academy.svg" title="Segment University: Segment App Overview" content="Want a video tour of the Segment workpsace? Head over to Segment University! (Must be logged in to access.)" %}

### What's a Workspace?

Expand Down