Skip to content

Commit 02ca8f0

Browse files
author
markzegarelli
committed
conflicts
2 parents 00916cb + cc373e2 commit 02ca8f0

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

‎src/connections/sources/catalog/cloud-apps/qualtrics/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-so
99

1010
Qualtrics maintains this source. For any issues with the source, [contact the Qualtrics Support team](mailto:[email protected]).
1111

12-
_**NOTE:** The Qualtrics Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on February 15, 2023. If you are interested in joining their beta program or have any feedback to help improve the Qualtrics Source and its documentation, [let the Qualtrics team know](mailto:[email protected])!_
12+
> info "Beta Source"
13+
> The Qualtrics Source is in beta, which means that they are still actively developing the source. This doc was last updated on February 15, 2023. If you are interested in joining their beta program or have any feedback to help improve the Qualtrics Source and its documentation, [let the Qualtrics team know](mailto:[email protected])!_
1314
1415
## Getting started
1516

‎src/connections/spec/common.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -116,26 +116,25 @@ Beyond this common structure, each API call adds a few specialized top-level fie
116116

117117
Context is a dictionary of extra information that provides useful context about a datapoint, for example the user's `ip` address or `locale`. You should **only use** Context fields for their intended meaning.
118118

119-
| Field | Type | Description |
120-
|-------------|---------|--------------------------|
121-
| `active` | Boolean | Whether a user is active. <br><br> This is usually used to flag an `.identify()` call to just update the traits but not "last seen." |
122-
| `app` | Object | dictionary of information about the current application, containing `name`, `version`, and `build`. <br><br> This is collected automatically from the mobile libraries when possible. |
123-
| `campaign` | Object | Dictionary of information about the campaign that resulted in the API call, containing `name`, `source`, `medium`, `term`, `content`, and any other custom UTM parameter. <br><br> This maps directly to the common UTM campaign parameters. |
124-
| `device` | Object | Dictionary of information about the device, containing `id`, `advertisingId`, `manufacturer`, `model`, `name`, `type`, and `version`. |
125-
| `ip` | String | Current user's IP address. |
126-
| `library` | Object | Dictionary of information about the library making the requests to the API, containing `name` and `version`. |
127-
| `locale` | String | Locale string for the current user, for example `en-US`. |
128-
| `network` | Object | Dictionary of information about the current network connection, containing `bluetooth`, `carrier`, `cellular`, and `wifi`.
129-
If the `context.network.cellular` and `context.network.wifi` fields are empty, then the user is offline. |
130-
| `os` | Object | Dictionary of information about the operating system, containing `name` and `version`. |
131-
| `page` | Object | Dictionary of information about the current page in the browser, containing `path`, `referrer`, `search`, `title` and `url`. This is automatically collected by [Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/#context--traits). |
132-
| `referrer` | Object | Dictionary of information about the way the user was referred to the website or app, containing `type`, `name`, `url`, and `link`. |
133-
| `screen` | Object | Dictionary of information about the device's screen, containing `density`, `height`, and `width`. |
134-
| `timezone` | String | Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example `America/New_York`. |
135-
| `groupId` | String | Group / Account ID. <br><br> This is useful in B2B use cases where you need to attribute your non-group calls to a company or account. It is relied on by several Customer Success and CRM tools. |
136-
| `traits` | Object | Dictionary of `traits` of the current user. <br><br> This is useful in cases where you need to `track` an event, but also associate information from a previous `identify` call. You should fill this object the same way you would fill traits in an [identify call](/docs/connections/spec/identify/#traits). |
137-
| `userAgent` | String | User agent of the device making the request. |
138-
| `channel` | String | where the request originated from: server, browser or mobile |
119+
| Field | Type | Description |
120+
| -------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
121+
| `active` | Boolean | Whether a user is active. <br><br> This is usually used to flag an `.identify()` call to just update the traits but not "last seen." |
122+
| `app` | Object | dictionary of information about the current application, containing `name`, `version`, and `build`. <br><br> This is collected automatically from the mobile libraries when possible. |
123+
| `campaign` | Object | Dictionary of information about the campaign that resulted in the API call, containing `name`, `source`, `medium`, `term`, `content`, and any other custom UTM parameter. <br><br> This maps directly to the common UTM campaign parameters. |
124+
| `device` | Object | Dictionary of information about the device, containing `id`, `advertisingId`, `manufacturer`, `model`, `name`, `type`, and `version`. |
125+
| `ip` | String | Current user's IP address. |
126+
| `library` | Object | Dictionary of information about the library making the requests to the API, containing `name` and `version`. |
127+
| `locale` | String | Locale string for the current user, for example `en-US`. |
128+
| `network` | Object | Dictionary of information about the current network connection, containing `bluetooth`, `carrier`, `cellular`, and `wifi`. If the `context.network.cellular` and `context.network.wifi` fields are empty, then the user is offline. |
129+
| `os` | Object | Dictionary of information about the operating system, containing `name` and `version`. |
130+
| `page` | Object | Dictionary of information about the current page in the browser, containing `path`, `referrer`, `search`, `title` and `url`. This is automatically collected by [Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/#context--traits). |
131+
| `referrer` | Object | Dictionary of information about the way the user was referred to the website or app, containing `type`, `name`, `url`, and `link`. |
132+
| `screen` | Object | Dictionary of information about the device's screen, containing `density`, `height`, and `width`. |
133+
| `timezone` | String | Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example `America/New_York`. |
134+
| `groupId` | String | Group / Account ID. <br><br> This is useful in B2B use cases where you need to attribute your non-group calls to a company or account. It is relied on by several Customer Success and CRM tools. |
135+
| `traits` | Object | Dictionary of `traits` of the current user. <br><br> This is useful in cases where you need to `track` an event, but also associate information from a previous `identify` call. You should fill this object the same way you would fill traits in an [identify call](/docs/connections/spec/identify/#traits). |
136+
| `userAgent` | String | User agent of the device making the request. |
137+
| `channel` | String | where the request originated from: server, browser or mobile |
139138

140139

141140
## Context fields automatically collected
@@ -180,7 +179,7 @@ Other libraries only collect `context.library`, any other context variables must
180179
| screen.height | | ✅ | ✅ |
181180
| screen.width | | ✅ | ✅ |
182181
| traits | | ✅ | ✅ |
183-
| userAgent | ✅ | | ✅ |
182+
| userAgent | ✅ | | ✅ |
184183
| timezone | | ✅ | ✅ |
185184

186185
- IP Address isn't collected by Segment's libraries, but is instead filled in by Segment's servers when it receives a message for **client side events only**.
@@ -215,12 +214,12 @@ Every API call has four timestamps, `originalTimestamp`, `timestamp`, `sentAt`,
215214
216215
### Timestamp overview
217216

218-
| Timestamp | Calculated | Description |
219-
|----------------|-----------------|-----------------|
220-
| `originalTimestamp` | Time on the client device when call was invoked <br> **OR** <br> The `timestamp` value manually passed in through server-side libraries. | Used by Segment to calculate `timestamp`. <br><br> **Note:** `originalTimestamp` is not useful for analysis since it's not always trustworthy as it can be easily adjusted and affected by clock skew. |
221-
| `sentAt` | Time on client device when call was sent. <br> **OR** <br> `sentAt` value manually passed in. | Used by Segment to calculate `timestamp`. <br><br> **Note:** `sentAt` is not useful for analysis since it's not always trustworthy as it can be easily adjusted and affected by clock skew. |
222-
| `receivedAt` | Time on Segment server clock when call was received | Used by Segment to calculate `timestamp`, and used as sort key in Warehouses. <br><br> **Note:** For max query speed, `receivedAt` is the recommended timestamp for analysis when chronology does not matter as chronology is not ensured. |
223-
| `timestamp` | Calculated by Segment to correct client-device clock skew using the following formula:<br> `receivedAt` - (`sentAt` - `originalTimestamp`) | Used by Segment to send to downstream destinations, and used for historical replays. <br><br>**Note:** Recommended timestamp for analysis when chronology does matter. |
217+
| Timestamp | Calculated | Description |
218+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
219+
| `originalTimestamp` | Time on the client device when call was invoked <br> **OR** <br> The `timestamp` value manually passed in through server-side libraries. | Used by Segment to calculate `timestamp`. <br><br> **Note:** `originalTimestamp` is not useful for analysis since it's not always trustworthy as it can be easily adjusted and affected by clock skew. |
220+
| `sentAt` | Time on client device when call was sent. <br> **OR** <br> `sentAt` value manually passed in. | Used by Segment to calculate `timestamp`. <br><br> **Note:** `sentAt` is not useful for analysis since it's not always trustworthy as it can be easily adjusted and affected by clock skew. |
221+
| `receivedAt` | Time on Segment server clock when call was received | Used by Segment to calculate `timestamp`, and used as sort key in Warehouses. <br><br> **Note:** For max query speed, `receivedAt` is the recommended timestamp for analysis when chronology does not matter as chronology is not ensured. |
222+
| `timestamp` | Calculated by Segment to correct client-device clock skew using the following formula:<br> `receivedAt` - (`sentAt` - `originalTimestamp`) | Used by Segment to send to downstream destinations, and used for historical replays. <br><br>**Note:** Recommended timestamp for analysis when chronology does matter. |
224223

225224

226225
### originalTimestamp

0 commit comments

Comments
 (0)