Skip to content

Commit d591ee0

Browse files
parlato-segmentparlato-segment
committed
Merge branch 'master' of github.com:segmentio/segment-docs into pd-265
2 parents 2257e95 + 535b045 commit d591ee0

File tree

6 files changed

+186
-16
lines changed

6 files changed

+186
-16
lines changed

‎src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination categories last updated 2020-07-13
2+
# destination categories last updated 2020-07-31
33
items:
44
- display_name: Email Marketing
55
slug: email-marketing

‎src/_data/catalog/destinations.yml

Lines changed: 106 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination data last updated 2020-07-22
2+
# destination data last updated 2020-07-31
33
items:
44
- display_name: ActiveCampaign
55
slug: activecampaign
@@ -4172,13 +4172,6 @@ items:
41724172
You can find your API Key in the Segment Integration page in your admin
41734173
settings.
41744174
settings: []
4175-
- name: companyCustomFields
4176-
display_name: Company Custom Fields
4177-
type: LIST
4178-
deprecated: false
4179-
required: false
4180-
description: Segment traits to be imported as custom fields on the company
4181-
settings: []
41824175
- name: customFields
41834176
display_name: Custom Fields
41844177
type: LIST
@@ -7106,6 +7099,19 @@ items:
71067099

71077100
```
71087101
settings: []
7102+
- name: limitedDataUse
7103+
display_name: Limited Data Use
7104+
type: BOOLEAN
7105+
deprecated: false
7106+
required: false
7107+
description: >-
7108+
The Limited Data Use (LDU) setting controls whether or not Limited Data
7109+
Use mode is set in Facebook's Data Processing Options. When enabling LDU,
7110+
Segment will send default user geography options to request that Facebook
7111+
geolocate the event. To override the default geography options set the
7112+
values in the `Facebook App Events` integrations object under the
7113+
`dataProcessingOptions` key.
7114+
settings: []
71097115
- name: appEvents
71107116
display_name: Map your events to Standard FB App Events
71117117
type: MAP
@@ -7213,6 +7219,18 @@ items:
72137219
page_view: false
72147220
track: true
72157221
settings:
7222+
- name: limitedDataUse
7223+
display_name: Limited Data Use
7224+
type: BOOLEAN
7225+
deprecated: false
7226+
required: false
7227+
description: >-
7228+
The Limited Data Use (LDU) setting controls whether or not Data Processing
7229+
Options are sent to Facebook. When enabling LDU, you **must** set the user
7230+
geography values in the `Facebook Offline Conversions` integration options
7231+
under the `dataProcessingOptions` key. If you do not pass specific
7232+
geography values, Segment will default to empty Data Processing Options.
7233+
settings: []
72167234
- name: completeRegistrations
72177235
display_name: Map Track Events as CompleteRegistration Conversions to Event Set IDs
72187236
type: MAP
@@ -7370,6 +7388,18 @@ items:
73707388
custom events inside their interface. Enter your event name in the left
73717389
column and your pixel ID in the right column.
73727390
settings: []
7391+
- name: limitedDataUse
7392+
display_name: Limited Data Use
7393+
type: BOOLEAN
7394+
deprecated: false
7395+
required: false
7396+
description: >-
7397+
The Limited Data Use (LDU) setting controls whether or not Limited Data
7398+
Use mode is set in the FB Pixel SDK. When enabling LDU, Segment will send
7399+
default user geography options to request that Facebook geolocate the
7400+
event. To override the default geography options set the values in the
7401+
analytics.js Load Options under the key `dataProcessingOptions`.
7402+
settings: []
73737403
- name: contentTypes
73747404
display_name: Map Categories to FB Content Types
73757405
type: MAP
@@ -15272,10 +15302,9 @@ items:
1527215302
- Surveys
1527315303
components:
1527415304
- type: WEB
15275-
- type: CLOUD
1527615305
platforms:
1527715306
browser: true
15278-
server: true
15307+
server: false
1527915308
mobile: false
1528015309
browserUnbundlingSupported: false
1528115310
browserUnbundlingPublic: true
@@ -15306,8 +15335,8 @@ items:
1530615335
server: false
1530715336
cloud:
1530815337
web: false
15309-
mobile: true
15310-
server: true
15338+
mobile: false
15339+
server: false
1531115340
previous_names:
1531215341
- Pendo
1531315342
- display_name: Perfect Audience
@@ -15874,6 +15903,70 @@ items:
1587415903
server: true
1587515904
previous_names:
1587615905
- Pointillist
15906+
- display_name: PostHog
15907+
slug: posthog
15908+
name: catalog/destinations/posthog
15909+
description: 'Self-hosted, open source product analytics'
15910+
hidden: false
15911+
url: connections/destinations/catalog/posthog
15912+
status: PUBLIC_BETA
15913+
logo:
15914+
url: >-
15915+
https://public-segment-devcenter-production.s3.amazonaws.com/5d042cef-4694-4866-98c6-a922cfa1f715.svg
15916+
mark:
15917+
url: >-
15918+
https://public-segment-devcenter-production.s3.amazonaws.com/d7a2a57f-4ae9-4018-a560-a0ce3a4dfc2e.svg
15919+
categories:
15920+
- Analytics
15921+
- Raw Data
15922+
- Heatmaps & Recordings
15923+
- A/B Testing
15924+
components: []
15925+
platforms:
15926+
browser: true
15927+
server: true
15928+
mobile: true
15929+
browserUnbundlingSupported: false
15930+
browserUnbundlingPublic: false
15931+
methods:
15932+
alias: true
15933+
group: false
15934+
identify: true
15935+
page_view: true
15936+
track: true
15937+
settings:
15938+
- name: apiKey
15939+
display_name: API Key
15940+
type: STRING
15941+
deprecated: false
15942+
required: true
15943+
string_validators:
15944+
regexp: '^.{8,}$'
15945+
description: Go to /setup to find your API Key
15946+
settings: []
15947+
- name: postHogInstance
15948+
display_name: PostHog instance
15949+
type: STRING
15950+
deprecated: false
15951+
required: false
15952+
string_validators:
15953+
regexp: ''
15954+
description: >-
15955+
If you're self-hosting PostHog, add the url of your instance:
15956+
https://posthog-example.herokuapp.com. If you're using app.posthog.com you
15957+
can leave this field empty.
15958+
settings: []
15959+
connection_modes:
15960+
device:
15961+
web: false
15962+
mobile: false
15963+
server: false
15964+
cloud:
15965+
web: false
15966+
mobile: false
15967+
server: false
15968+
previous_names:
15969+
- PostHog
1587715970
- display_name: ProfitWell
1587815971
slug: profitwell
1587915972
name: catalog/destinations/profitwell
@@ -23853,7 +23946,7 @@ items:
2385323946
string_validators:
2385423947
regexp: '^.{8,}$'
2385523948
description: >-
23856-
The mabl API Key is available in the mabl up under settings > APIs or bu
23949+
The mabl API Key is available in the mabl app under settings > APIs or by
2385723950
navigating directly to https://app.mabl.com/workspaces/-/settings/apis
2385823951
settings: []
2385923952
connection_modes:

‎src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# source cateogries last updated 2020-07-13
2+
# source cateogries last updated 2020-07-31
33
items:
44
- display_name: Server
55
slug: server

‎src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# sources last updated 2020-07-13
2+
# sources last updated 2020-07-31
33
items:
44
- display_name: .NET
55
slug: net

‎src/connections/destinations/catalog/facebook-app-events/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,8 @@ analytics.track({
188188

189189
#### iOS Device Mode
190190

191+
You must use the Facebbok App Events integration SDK version `2.0.0` or later to call `setDataProcessingOptions` when you enable the **Use Limited Data Use** destination setting. Events sent from earlier versions of the Facebook App Events integration SDK cannot call `setDataProcessingOptions`, but Facebook still has access to the IP address in the events to process LDU based on geolocation.
192+
191193
When you use Segment’s mobile libraries, you must set the Data Processing Options when you declare the destination in your app delegate’s instance. The example below shows how you might set custom Data Processing parameters in an iOS project.
192194

193195
```objc

‎src/connections/destinations/catalog/posthog/index.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: PostHog Destination
3+
rewrite: true
4+
---
5+
[PostHog](https://posthog.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is self-hosted, open-source analytics product. Get the same powerful features as other product analytics software but keep full control over your data.
6+
7+
This destination is maintained by PostHog. For any issues with the destination, [contact the PostHog Support team](mailto:[email protected]).
8+
9+
## Getting Started
10+
11+
{% include content/connection-modes.md %}
12+
13+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
14+
2. Search for "PostHog" in the Destinations Catalog, and select the PostHog destination.
15+
3. Choose which Source should send data to the PostHog destination.
16+
4. Go to your [PostHog set up page](https://app.posthog.com/setup), and find and copy the **API key**.
17+
5. Enter the PostHog API Key that you copied in the PostHog destination settings in Segment.
18+
19+
> note ""
20+
> **Note**: If you're hosting your own PostHog instance, add the URL of your instance without the trailing slash in the **PostHog instance** setting. For example, `https://posthog-example.herokuapp.com`
21+
22+
## Page
23+
24+
If you aren't familiar with the Segment Spec, take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like:
25+
26+
```js
27+
analytics.page()
28+
```
29+
30+
Segment sends Page calls to PostHog as a `$pageview`.
31+
32+
33+
## Screen
34+
35+
If you aren't familiar with the Segment Spec, take a look at the [Screen method documentation](https://segment.com/docs/connections/spec/screen/) to learn about what it does. An example call would look like:
36+
37+
```obj
38+
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
39+
```
40+
41+
Segment sends Screen calls to PostHog as a `$screen` event.
42+
43+
44+
## Identify
45+
46+
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
47+
48+
```js
49+
analytics.identify('userId123', {
50+
email: '[email protected]'
51+
});
52+
```
53+
54+
Segment sends Identify calls to PostHog as an `identify` event. Data from Identify calls appears in PostHog under the **People** tab.
55+
56+
57+
## Track
58+
59+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
60+
61+
```js
62+
analytics.track('Login Button Clicked')
63+
```
64+
65+
Segment sends Track calls to PostHog as a `track` event.
66+
67+
## Alias
68+
69+
If you aren't familiar with the Segment Spec, take a look at the [Alias method documentation](https://segment.com/docs/connections/spec/alias/) to learn about what it does. An example call would look like:
70+
71+
```js
72+
analytics.alias('507f191e81')
73+
```
74+
75+
Segment sends Alias calls to PostHog as an `alias` event.

0 commit comments

Comments
 (0)