Skip to content

Commit b5a9907

Browse files
authored
Merge pull request #6112 from kobalski/peaka/destination
Add Peaka Destination Documentation
2 parents e382fa1 + 10a4c2d commit b5a9907

File tree

1 file changed

+100
-0
lines changed
  • src/connections/destinations/catalog/peaka

1 file changed

+100
-0
lines changed
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Peaka Destination
3+
id: 651ea97b7982672f1d66b93c
4+
beta: true
5+
---
6+
7+
[Peaka](https://peaka.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a Zero-ETL platform that connects to any source. With Peak you can ingest high-volume event and streaming data, and replace batch with real-time access.
8+
9+
By integrating Peaka with their Segment workspace, users can designate Peaka as one of their destinations. This means that events such as pages, screens, tracks,
10+
and more send directly to Peaka's Segment data catalog. With this integration, Peaka users can begin querying their product events.
11+
12+
Peaka maintains this destination. For any issues with the destination, [contact the Peaka Support team](mailto:[email protected]).
13+
14+
## Getting started
15+
16+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for **Peaka**
17+
2. Select **Peaka** and click **Add destination**.
18+
3. Choose which source should send data to the Peaka destination.
19+
4. Log in to [Peaka](https://peaka.studio/){:target="_blank"}.
20+
5. Follow the steps in the [Peaka documentation](https://www.peaka.com/docs/integrations/segment/){:target="_blank"} to create your Segment catalog and obtain your **API key**.
21+
6. Enter the **API Key** in the **Peaka** destination settings in the Segment UI.
22+
23+
## Supported methods
24+
25+
Peaka supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
26+
27+
### Page
28+
29+
Segment sends [Page](/docs/connections/spec/page) calls to Peaka. For example:
30+
31+
```js
32+
analytics.page("Retail Page", "Home");
33+
```
34+
35+
You can see Page event data in your Peaka Catalog under the pages table.
36+
37+
### Screen
38+
39+
Segment sends [Screen](/docs/connections/spec/screen) calls to Peaka. For example:
40+
41+
```obj-c
42+
[[SEGAnalytics sharedAnalytics] screen:@"Home"
43+
properties:@{ @"Feed Type": @"private" }];
44+
```
45+
46+
You can see Screen event data in your Peaka Catalog under the screens table.
47+
48+
### Identify
49+
50+
Segment sends [Identify](/docs/connections/spec/identify) calls to Peaka. For example:
51+
52+
```js
53+
analytics.identify("97980cfea0067", {
54+
name: "Peter Gibbons",
55+
56+
plan: "premium",
57+
logins: 5,
58+
});
59+
```
60+
61+
You can see Identify event data in your Peaka Catalog under the identifies table.
62+
63+
### Track
64+
65+
Segment sends[Track](/docs/connections/spec/track) calls to Peaka. For example:
66+
67+
```js
68+
analytics.track("User Registered", {
69+
plan: "Pro Annual",
70+
accountType: "Facebook",
71+
});
72+
```
73+
74+
You can see Track event data in your Peaka Catalog under the tracks table.
75+
76+
### Group
77+
78+
Segment sends [Group](/docs/connections/spec/group) calls to Peaka. For example:
79+
80+
```js
81+
analytics.group("0e8c78ea9d97a7b8185e8632", {
82+
name: "Initech",
83+
industry: "Technology",
84+
employees: 329,
85+
plan: "enterprise",
86+
"total billed": 830,
87+
});
88+
```
89+
90+
You can see Group event data in your Peaka Catalog under the groups table.
91+
92+
### Alias
93+
94+
Segment sends [Group](/docs/connections/spec/alias) calls to Peaka. For example:
95+
96+
```js
97+
analytics.alias("507f191e81");
98+
```
99+
100+
You can see Alias event data in your Peaka Catalog under the aliases table.

0 commit comments

Comments
 (0)