Skip to content

Commit b5c349d

Browse files
tcgilbertmarkzegarelli
andauthored
Add new Correlated destination docs (#3288)
* Add new Correlated destination docs * Edits and cleanup Co-authored-by: markzegarelli <[email protected]>
1 parent d2d8326 commit b5c349d

File tree

2 files changed

+80
-2
lines changed

2 files changed

+80
-2
lines changed

.github/styles/segment/relative-url.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@ message: 'Link to Segment docs "%s" must be relative.'
33
level: warning
44
scope: raw
55
raw:
6-
- '\[.+\]\(https://(www.)?segment.com/docs.*\)'
7-
6+
- '\[.+\]\(https://(www.)?segment.com/docs.*\)'
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Correlated Destination
3+
id: 60df6d4c038b872f10c54801
4+
---
5+
6+
[Correlated](https://www.getcorrelated.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_new"} is the first product-led revenue platform built to help you and your sales teams take action based on how customers are using your product.
7+
8+
This destination is maintained by Correlated. For any issues with the destination, [contact the Correlated Support team](mailto:[email protected]).
9+
10+
> success ""
11+
> Set up a free account with Correlated by visiting their [website](https://www.getcorrelated.com/get-started){:target="_new"}.
12+
13+
## Getting Started
14+
15+
### Connect with OAuth
16+
1. Log in to the Correlated application.
17+
2. Go to [Correlated integrations](https://app.getcorrelated.com/integrations) and select the Segment integration.
18+
3. Click **Connect to Segment** to connect with OAuth.
19+
4. Select the relevant Sources that you want to include (Correlated recommends that you include your website and application)
20+
21+
### Connect with an API Key
22+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
23+
2. Search for "Correlated" in the Destinations Catalog, and select the "Correlated" destination.
24+
3. Choose which Source should send data to the "Correlated" destination.
25+
4. Go to [Correlated integrations](https://app.getcorrelated.com/integrations) and click on the "Segment" integration.
26+
5. Copy the "Segment API key".
27+
6. Enter the "Segment API Key" in the "Correlated" destination settings in Segment.
28+
29+
## Supported Methods
30+
31+
Correlated supports the following methods.
32+
33+
### Page
34+
35+
If you aren't familiar with the Segment Spec, take a look at the [Page method documentation](/docs/connections/spec/page/) to learn about what it does. An example call would look like:
36+
37+
```js
38+
analytics.page()
39+
```
40+
41+
Segment sends Page calls to Correlated as a `page` event. Correlated displays these events as `Page views` by default.
42+
43+
44+
### Group
45+
46+
If you aren't familiar with the Segment Spec, take a look at the [Group method documentation](/docs/connections/spec/group/) to learn about what it does. An example call would look like:
47+
```js
48+
analytics.group("0e8c78ea9d97a7b8185e8632", {
49+
name: "Initech",
50+
industry: "Technology",
51+
employees: 329,
52+
plan: "enterprise",
53+
"total billed": 830
54+
});
55+
```
56+
57+
Segment sends Group calls to Correlated as a `group` event. `Group` events are augmented with group traits. Correlated displays these events as `Accounts` by default. It's best to include a name as a trait, as Correlated will use this to populate Account views by default.
58+
59+
### Identify
60+
61+
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
62+
63+
```js
64+
analytics.identify('userId123', {
65+
66+
});
67+
```
68+
69+
Segment sends Identify calls to Correlated as an `identify` event. Correlated displays these events as `Users` by default. `Track` event data is augmented with identify traits. It's best to include email as a trait, as Correlated will use email to populate User views by default.
70+
71+
### Track
72+
73+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does. An example call would look like:
74+
75+
```js
76+
analytics.track('Login Button Clicked')
77+
```
78+
79+
Segment sends Track calls to Correlated as a `track` event. Track events should be flattened whenever possible. For example, rather than "Button Click" as a track event with "Onboarding Form Submit" as a property, use "Onboarding Form Submit Button Click". `Product Events` can be filtered and grouped by identify traits or group traits.

0 commit comments

Comments
 (0)