Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[DOCSPLAT-2993] Modifications for serialization#8050

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
forstisabella merged 11 commits intosegmentio:developfromlopenchi:DOCSPLAT-2993
Oct 16, 2025
Merged
Show file tree
Hide file tree
Changes fromall 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
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ When you enable Chartbeat in the Segment web app, your changes appear in the Seg

Chartbeat is only supported on the client-side.

- - -


##Page
Expand Down
2 changes: 1 addition & 1 deletionsrc/connections/destinations/catalog/clicky/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ id: 54521fd525e721e32a72eea2
Our Clicky destination code is open-source on GitHub. You can check out the code [in the @segment-integrations/analytics.js-integration-clicky](https://github.com/segment-integrations/analytics.js-integration-clicky){:target="_blank"} repository.


## GettingStarted
## Gettingstarted

1. From the Segment web app, click **Catalog**.
2. Search for "Clicky" in the Catalog, select it, and choose which of your sources to connect the destination to.
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ id: 55677dfd0a20f4e22f0fb39a
---
This destination is maintained by ClientSuccess.

## GettingStarted (for CSMs)
## Gettingstarted (for CSMs)

If your engineers have already set up Segment, adding Segment data to ClientSuccess is straightforward. All you need to do is turn on the destination.

Expand All@@ -17,7 +17,8 @@ To turn on the destination, do the following:

**Note:** Because ClientSuccess focuses on group level events, you must pass group information before your events will show up. If you turn on the ClientSuccess destination in Segment and don't see events in ClientSuccess after 24 hours, it may be that your engineers need to send group information to Segment using Segment's `group` call.

## Getting Started (for Developers)

## Getting started (for developers)

ClientSuccess supports the `identify`, `group`, `track`, and `page` methods of Segment.

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/cubitic/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@ The Cubitic application key can be obtained by contacting signup@cubitic.io

Cubitic supports the `identify` and `track` methods.

- - -

## Identify

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/cxense/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ To get started with Cxense and Segment, you'll need the following:

Assuming these criteria are met, you can add Cxense as a destination for your desired source in your Segment account.

- - -

## Page

Expand Down
2 changes: 1 addition & 1 deletionsrc/connections/destinations/catalog/firebase/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ buildscript {
apply plugin: 'com.google.gms.google-services'
```

> warning "Use the`aar` package when adding the Segment-Firebase SDK"
> warning "Use the aar package when adding the Segment-Firebase SDK"
> The Firebase SDK requires Android resources which are available on `aar` packages.


Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ Once your application is set up and instrumented with Segment, turn on Framed in

Framed supports the `identify` and `track` methods.

- - -

## Identify

Expand Down
14 changes: 7 additions & 7 deletionssrc/connections/destinations/catalog/freshsales/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ You can use `identify` to create a lead or a contact when a website visitor fill
### User ID
`userId` is a mandatory field which is used to identify the lead or contact in Freshsales. If your user identifier is not email, then email has to be a part of traits.

<pre>
```json
{
"userId": "97980cfea0067",
"traits": {
Expand All@@ -32,11 +32,11 @@ You can use `identify` to create a lead or a contact when a website visitor fill
}
}
}
</pre>
```

By default, every `identity` is created as a lead. If you'd like an identity to be a contact, you'd need to pass `fs_contact` as `true` as a part of traits.

<pre>
```json
{
"userId" : "97980cfea0067",
"traits" : {
Expand All@@ -50,7 +50,7 @@ By default, every `identity` is created as a lead. If you'd like an identity to
}
}
}
</pre>
```

### Traits
`traits` are pieces of information you know about a user that are included in an `identify` method.
Expand All@@ -72,7 +72,7 @@ As part of traits, you can send custom fields created in Freshsales by using the
### Objects:
Accounts and Deals associated to a contact or lead can also be updated in Freshsales. The objects company and deal in the identity correspond to the Accounts and Deals in Freshsales. You can pass the `traits` of the company or the deal along with the respective objects in the identity.

```
```json
{
"userId" : "97980cfea0067",
"traits" : {
Expand All@@ -98,7 +98,7 @@ You can track activities of your website visitors. If a user is subscribing to a
### Track request payload


```
```json
{
"userId" : "john.doe@example.com",
"event": "Email Bounced",
Expand All@@ -120,7 +120,7 @@ When you call a `page` event, we send a pageview to Freshsales. You can send ext

### Sample Page request payload

```
```json
{
"userId" : "john.doe@example.com",
"name": "Page view",
Expand Down
6 changes: 3 additions & 3 deletionssrc/connections/destinations/catalog/fullstory/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ analytics.identify("userId");

In addition, Segment will send over along any traits included in the `identify` call. The example call below would send over both `plan` and `logins`.

```
```js
analytics.identify("userId123", {
plan: "premium",
logins: 5
Expand All@@ -50,7 +50,7 @@ analytics.identify("userId123", {

Both `email` and `displayName` are special traits that will be passed to FullStory to be used in their interface as explained in [FullStory's docs](https://help.fullstory.com/hc/en-us/articles/360020828113){:target="_blank"}. These traits are optional.

```
```js
analytics.identify("userId123", {
email: "john.doe@example.com",
displayName: "John Doe"
Expand All@@ -63,7 +63,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th

An example call would look like:

```
```js
analytics.track('Product Purchased', {
order_ID: '2969302398',
category: 'boots',
Expand Down
2 changes: 0 additions & 2 deletionssrc/connections/destinations/catalog/gauges/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,14 +10,12 @@ This means you should remove Gauges' snippet from your page.

Gauges starts automatically collecting data on your site.

- - -


## Page

When you call [`page`](/docs/connections/spec/page/), we call Gauges' `track` method with no arguments.

- - -


## Troubleshooting
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ To enable consent mode for your Google Ads (Gtag) destination, you can choose fr
* **Option 1:**
1. Set the consent defaults by implementing the `ready()` method to set consent defaults.

```
```js
analytics.ready(function() {
window.gtag('consent', 'default', {
'ad_storage': 'granted',
Expand All@@ -62,7 +62,7 @@ To enable consent mode for your Google Ads (Gtag) destination, you can choose fr

3. Pass the information to Gtag.js by calling `gtag` inside the Segment `ready`() method.

```
```js
analytics.ready(function() {
window.gtag('consent', 'update', {
'ad_storage': 'denied',
Expand Down
2 changes: 0 additions & 2 deletionssrc/connections/destinations/catalog/gosquared/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@ Your GoSquared Now dashboard will instantly start showing the number of visitors

GoSquared supports mobile, webpage and server-side tracking.

- - -

## Website Tracking

Expand All@@ -22,7 +21,6 @@ When you enter your GoSquared site token into Segment, website tracking will aut

To track data using Segment's mobile and server-side sources, you will need to enter a GoSquared API Key, which can be created in your [GoSquared account](https://www.gosquared.com/settings/api){:target="_blank"}. The API Key must have "Write Tracking" access. All functionality is supported by mobile and server-side tracking.

- - -

## Page

Expand Down
4 changes: 4 additions & 0 deletionssrc/connections/destinations/catalog/gtag/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,8 @@ analytics.track('Logged In');

Segment sends these event attributes to Google Analytics:

| Event Attributes | Info |
| ------------------ | --------- |
| **Event Category** | All |
| **Event Action** | Logged In |

Expand All@@ -150,6 +152,8 @@ In this example, Segment sends all Google Analytics event parameters:

Segment sends these event attributes to Google Analytics:

| Event Attributes | Info |
| ------------------ | --------- |
| **Event Category** | Account |
| **Event Action** | Logged In |
| **Event Label** | Premium |
Expand Down
2 changes: 1 addition & 1 deletionsrc/connections/destinations/catalog/hawkei/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,6 @@ You'll want to create events that are part of critical paths in your application

## Troubleshooting

## AnonymousId
### AnonymousId

All requests to Hawkei require an `anonymousId` to be set. Segment sets this automatically on client-side libraries, but for server side libraries (php, Ruby etc) this needs to be explicitly set.
29 changes: 15 additions & 14 deletionssrc/connections/destinations/catalog/hotjar/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,19 +34,20 @@ Identify calls that do not have a User ID value will not be sent to Hotjar.

Currently, the Hotjar Identify API**does not** support ingesting values passed as nested objects or lists over your identify Spec:

```js
```json
"traits": {
"name":"Peter Gibbons",
"email":"peter@example.com",
"plan":"premium",
"logins":5,
"address": {
"street":"6th St",
"city":"San Francisco",
"state":"CA",
"postalCode":"94103",
"country":"USA"
}
"name":"Peter Gibbons",
"email":"peter@example.com",
"plan":"premium",
"logins":5,
"address": {
"street":"6th St",
"city":"San Francisco",
"state":"CA",
"postalCode":"94103",
"country":"USA"
}
}
```

In the example above, Hotjar rejects all the values in the`address` field.
Expand All@@ -62,8 +63,8 @@ Currently, the Hotjar Events API **does not** support ingesting event properties
```js
analytics.track("Experiment Viewed", {
experiment_id:"1234",
experiment_name:"new_upsell_UX"
variation_id:"1234b"
experiment_name:"new_upsell_UX",
variation_id:"1234b",
variation_name:"variant"
});
```
Expand Down
4 changes: 2 additions & 2 deletionssrc/connections/destinations/catalog/hydra/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ If you would like to use `track` event data, create a `Segment Product Usage Sca

If you're not familiar with the Segment Specs, take a look to understand what the[Identify method](/docs/connections/spec/identify/) does. An example call would look like:

```
```js
analytics.identify('userId123', {
email:'john.doe@example.com',
firstName:'John',
Expand All@@ -45,7 +45,7 @@ Identify calls will be sent to Hydra as an `identify` event. Upon receiving an I

If you're not familiar with the Segment Specs, take a look to understand what the[Track method](/docs/connections/spec/track/) does. An example call would look like:

```
```js
analytics.track('Device deploy started',
"properties": {
"feature":"Device management",
Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/impact/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,6 @@ For tracking on Web, you will need your...
4. Campaign ID
Your campaign id will be displayed in the top right corner of your Impact dashboard. It will be the four numbers next to your campaign name.

- - -

## Track

Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,5 @@ The alias call can be used to merge two user identities and their data to one. T

This call is currently only supported partially. Whenever a user is assigned to a group, the properties of this group and the group ID is added to the user's properties. This means there is no support for the user being in multiple groups.

- - -

Read the [Infinario guides](http://guides.infinario.com/){:target="_blank"} to see what can you do with the data you tracked.
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/iterable/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ When you enable the Iterable destination from the Segment app, your data starts
* [Automatically send a follow up email when your initial email goes unopened](https://segment.com/recipes/iterable-autoresponder-emails-when-unopened/)
-->

- - -

## Identify

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/keen/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@ When you enable Keen in the Segment web app, your changes appear in the Segment

Keen is supported on the client side and server side.

- - -

## Identify

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/librato/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@ When you enable Librato in the Segment web app, your changes appear in the Segme

Librato supports the Segment`track` method for both client-side and server-side.

- - -

##Track

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/livechat/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@ When you enable LiveChat in the Segment web app, your changes appear in the Segm

LiveChat is only supported on the client-side.

- - -

## Identify

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/marketo/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ When you enable Marketo in the Segment web app, your changes appear in the Segme
###Important Note:
Our client-side and server-side destinations each require**different** credentials for authentication. Read through the information below on`identify` calls for further information.

- - -

##Page and Track

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/mixpanel/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,7 +337,6 @@ analytics.track({

Segment doesn't map `$library_version` since that is reserved for Mixpanel's library version, not Segment's. Segment doesn't map to `$brand`.

- - -

## Features

Expand Down
3 changes: 0 additions & 3 deletionssrc/connections/destinations/catalog/olark/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@ When you enable Olark in the Segment web app, your changes appear in the Segment

Olark is only supported in device mode (on the client).

- - -

## Page

Expand All@@ -32,7 +31,6 @@ More documentation on the Olark API can be found [in Olark's docs](https://www.o

When you call [`track`](/docs/connections/spec/track/) or one of its helpers on analytics.js, we call Olark's `sendNotificationToOperator` function as `visitor triggered *eventName*`. You must enable this option with the *track* flag, because it can sometimes be bothersome.

- - -

## Features

Expand All@@ -52,7 +50,6 @@ analytics.ready(function(){

[Read the ready docs for more details](/docs/connections/sources/catalog/libraries/website/javascript/#ready)

- - -


## Record Live Chat Events
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ OneSignal will only track new users. If you have existing push notification data

OneSignal supports the `identify` and `track` methods and is currently only available on iOS using Segment.

- - -

## Identify & Track

Expand Down
1 change: 0 additions & 1 deletionsrc/connections/destinations/catalog/planhat/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@ The Segment Planhat destination is 100% handled through our servers, so you don'

The Segment Planhat destination supports Identify, Page, Track, and Group calls. For more information, see the [Segment Spec documentation](/docs/connections/spec/).

- - -

## Identify

Expand Down
Loading
Loading
[8]ページ先頭
©2009-2025 Movatter.jp