Skip to content

Commit f5a4b35

Browse files
committed
Add Peaka Destination Documentation
1 parent 0623393 commit f5a4b35

File tree

1 file changed

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

1 file changed

+113
-0
lines changed
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
title: Peaka Destination
3+
---
4+
5+
[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. Ingest high-volume event and streaming data. Replace batch with real-time access.
6+
7+
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,
8+
and more will be sent directly to Peaka's Segment data catalog. With this integration, Peaka users can begin querying their product events.
9+
10+
This destination is maintained by Peaka. For any issues with the destination, [contact the Peaka Support team](mailto:[email protected]).
11+
12+
## Getting started
13+
14+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="\_blank”} search for **Peaka**
15+
2. Select **Peaka** and click **Add Destination**
16+
3. Choose which Source should send data to the **Peaka** destination.
17+
4. Go to the [Peaka](https://peaka.studio/){:target="\_blank"}, create your Segment Catalog and copy the **API key**.
18+
5. Follow the steps in **Peaka** [Documentation](https://www.peaka.com/docs/integrations/segment/) on how to create your Segment Catalog and obtain your **API key**
19+
6. Enter the **API Key** in the **Peaka** destination settings in Segment.
20+
21+
## Supported methods
22+
23+
**Peaka** supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
24+
25+
### Page
26+
27+
Segment sends [Page](/docs/connections/spec/page) calls to **Peaka**. For example:
28+
29+
```js
30+
analytics.page("Retail Page", "Home");
31+
```
32+
33+
You can see **Page** event data in your Peaka Catalog under **pages** table.
34+
35+
### Screen
36+
37+
Segment sends [Screen](/docs/connections/spec/screen) calls to **Peaka**. For example:
38+
39+
```obj-c
40+
[[SEGAnalytics sharedAnalytics] screen:@"Home"
41+
properties:@{ @"Feed Type": @"private" }];
42+
```
43+
44+
You can see **Screen** event data in your Peaka Catalog under **screens** table.
45+
46+
### Identify
47+
48+
Segment sends [Identify](/docs/connections/spec/identify) calls to **Peaka**. For example:
49+
50+
```js
51+
analytics.identify("97980cfea0067", {
52+
name: "Peter Gibbons",
53+
54+
plan: "premium",
55+
logins: 5,
56+
});
57+
```
58+
59+
You can see **Identify** event data in your Peaka Catalog under **identifies** table.
60+
61+
### Track
62+
63+
Segment sends[Track](/docs/connections/spec/track) calls to **Peaka**. For example:
64+
65+
```js
66+
analytics.track("User Registered", {
67+
plan: "Pro Annual",
68+
accountType: "Facebook",
69+
});
70+
```
71+
72+
You can see **Track** event data in your Peaka Catalog under **tracks** table.
73+
74+
### Group
75+
76+
Segment sends [Group](/docs/connections/spec/group) calls to **Peaka**. For example:
77+
78+
```js
79+
analytics.group("0e8c78ea9d97a7b8185e8632", {
80+
name: "Initech",
81+
industry: "Technology",
82+
employees: 329,
83+
plan: "enterprise",
84+
"total billed": 830,
85+
});
86+
```
87+
88+
You can see **Group** event data in your Peaka Catalog under **groups** table.
89+
90+
### Alias
91+
92+
Segment sends [Group](/docs/connections/spec/alias) calls to **Peaka**. For example:
93+
94+
```js
95+
analytics.alias("507f191e81");
96+
```
97+
98+
You can see **Alias** event data in your Peaka Catalog under **aliases** table.
99+
100+
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
101+
102+
<!-- code_chunk_output -->
103+
104+
- [Getting started](#getting-started)
105+
- [Supported methods](#supported-methods)
106+
- [Page](#page)
107+
- [Screen](#screen)
108+
- [Identify](#identify)
109+
- [Track](#track)
110+
- [Group](#group)
111+
- [Alias](#alias)
112+
113+
<!-- /code_chunk_output -->

0 commit comments

Comments
 (0)