Skip to content

Commit 4620792

Browse files
committed
chore: small fixes for serialization of batch 2.2
1 parent a611f0f commit 4620792

File tree

18 files changed

+32
-52
lines changed

18 files changed

+32
-52
lines changed

src/connections/sources/about-cloud-sources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Cloud-App Sources (often shortened to Cloud Sources) allow you to pull in data f
99

1010
As in the basic tracking API, _objects_ usually contain information about a person or group which is updated over time, while _event_ data happens once, and is appended to a list.
1111

12-
### Event Cloud-App Sources
12+
## Event Cloud-App Sources
1313

1414
Event Cloud Sources can export their data both into Segment warehouses, and into other enabled Segment integrations that work with event data.
1515

16-
### Object Cloud-App Sources
16+
## Object Cloud-App Sources
1717

1818
Object Cloud App Sources can export data and import it directly into a Segment warehouse. You *must* have a Segment warehouse enabled before you enable these. From the warehouse, you can analyze your data with SQL, use [Reverse ETL](/docs/connections/reverse-etl) to extract data, or use Engage SQL Traits to build audiences. Some examples of Object Cloud sources are Salesforce (account information), Zendesk (support cases), and Stripe (payments information).
1919

src/connections/sources/catalog/libraries/mobile/android/quickstart.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,6 @@ To get started, we recommend tracking just a few important events. You can alway
137137

138138
Once you've added a few `track` calls, **you're done!** You successfully instrumented your app! Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
139139

140-
---
141-
142140
## What's Next?
143141

144142
We just walked through the quickest way to get started with Segment using Analytics-Android. You might also want to check out Segment's full [Analytics-Android reference](/docs/connections/sources/catalog/libraries/mobile/android) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http-api/) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/go/quickstart.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,6 @@ To get started, we recommend tracking just a few important events. You can alway
107107

108108
Once you've added a few `track` calls, **you're done!** You successfully installed analytics tracking on your servers. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
109109

110-
111-
---
112-
113-
114110
## What's Next?
115111

116112
We just walked through the quickest way to get started with Segment using go. You might also want to check out our full [Go library reference](/docs/connections/sources/catalog/libraries/server/go/) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/go/v2/quickstart.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,6 @@ To get started, we recommend tracking just a few important events. You can alway
107107

108108
Once you've added a few `track` calls, **you're done!** You successfully installed analytics tracking on your servers. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
109109

110-
111-
---
112-
113-
114110
## What's Next?
115111

116112
We just walked through the quickest way to get started with Segment using go. You might also want to check out our full [Go library reference](/docs/connections/sources/catalog/libraries/server/go/) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/java/quickstart.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,6 @@ To get started, we recommend tracking just a few important events. You can alway
113113

114114
Once you've added a few `track` calls, **you're done!** You successfully installed Analytics tracking. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
115115

116-
117-
---
118-
119-
120116
## What's Next?
121117

122118
We just walked through the quickest way to get started with Segment using our Java library. You might also want to check out our full [reference](/docs/connections/sources/catalog/libraries/server/java) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/node/quickstart.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,6 @@ To get started with Analytics Node.js:
8989
9090
After you've added a few `track` calls, you've successfully installed analytics tracking on your servers. Now you're ready to turn on any destination from the Segment app.
9191
92-
---
93-
9492
## What's Next?
9593
9694
You can check out the full docs for [Analytics Node.js](/docs/connections/sources/catalog/libraries/server/node) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/object-api/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ Use the Segment Objects API to send business objects relevant to your business r
1010
> warning ""
1111
> Segment hasn't added support for the core `analytics-<language>` libraries so you'll need to use the Segment HTTP API directly or the independent Go(lang) client for now.
1212
13-
### Authentication
13+
## Authentication
1414

1515
Authenticate to the Objects API by sending your project's **Write Key** along with a request.
1616
Authentication uses HTTP Basic Auth, which involves a 'username:password' that is base64 encoded and pre-pended with the string 'Basic '.
1717

1818
In practice that means taking a Segment source **Write Key**,`'abc123'`, as the username, adding a colon, and then the password field is left empty. After base64 encoding `'abc123:'` becomes `'YWJjMTIzOg=='`; and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIzOg=='`.
1919

20-
### Source type
20+
## Source type
2121

2222
Set up an `HTTP API` source type in Segment. You will use this source write key for authenticating with the Objects API.
2323

24-
### Content-type
24+
## Content-type
2525

2626
In order to send data to Segment's HTTP API, the content-type header must be set to `'application/json'`.
2727

@@ -156,12 +156,14 @@ POST https://objects.segment.com/v1/set
156156

157157
This call sends a collection of "rooms". "rooms" becomes the table name in your data warehouse, and each individual object in the array becomes a row in that table.
158158

159+
| Field | Type | Description |
159160
|-------------------------|--------|-------------------------------------------------------------------------------------------|
160161
| `collection` *Required* | String | A string that represents the name of the collection. The collection name will become the table name in your data warehouse. Collection must consist of lowercase letters and underscores and maximum of 100 characters. Can not begin or end with an underscore. |
161162
| `objects` | Array | A required array of objects describing the objects and properties being set. Must consist of at least one JSON object and a maximum of 10. |
162163

163164
Each object inside of the objects array must consist of the following parameters:
164165

166+
| Parameter | Type | Description |
165167
|-------------------------|--------|-------------------------------------------------------------------------------------------|
166168
| `id` *Required* | String | The unique ID representing the object in the third party system. Maximum of 100 characters. |
167169
| `Properties` *Required* | Object | The object properties that represent the object. Example: Each value could be a string (ISO dates are parsed and recognized as `isodate` type), an integer, or a float (JSON types). Values cannot be lists or objects. Each value must be less than 32KB in size. |

src/connections/sources/catalog/libraries/server/object-bulk-api/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ It differs from the Object API in that it is designed to:
1414
> warning ""
1515
> At this time, Segment hasn't created tooling akin to core analytics-* libraries so you'll need to use Segment's HTTP API directly for now.
1616
17-
### Batched Object Data
17+
## Batched Object Data
18+
1819
The `Batched Object Data` the API accepts is a file of line separated objects, in JSON form, compressed using `Gzip`.
1920
The maximum size of a single `object` is 400KB and maximum uncompressed size of a file 512MB.
2021

@@ -23,25 +24,26 @@ Example objects:
2324
{"id":"1","collection":"users","properties":{"first_name":"John","last_name":"Smith"}}
2425
{"id":"2","collection":"users","properties":{"first_name":"Jane","last_name":"Doe"}}
2526
```
26-
27+
| Field | Type | Description |
2728
|-------------------------|--------|-------------------------------------------------------------------------------------------|
2829
| **`id`** *Required* | String | The unique ID representing the object in the third party system. <br><br> Maximum of 100 characters. |
2930
| **`collection`** *Required* | String | A string that represents the name of the collection. The collection name will become the table name in your data warehouse. <br><br> Collection must consist of lowercase letters and underscores and maximum of 100 characters. Can not begin or end with an underscore. |
3031
| **`Properties`** *Required* | Object | The object properties that represent the object. <br><br> Example: Each value could be a string (ISO dates are parsed and recognized as `isodate` type), an integer, or a float (JSON types). <br><br> Values cannot be lists or objects. Each value must be less than 32KB in size. |
3132

3233

33-
### Authentication
34+
## Authentication
3435

3536
Authenticate to the Objects Bulk API by sending your project's **Write Key** along with a request.
3637
Authentication uses HTTP Basic Auth, which involves a `username:password` that is base64 encoded and prepended with the string `Basic `.
3738

3839
In practice that means taking a Segment source **Write Key** encoding it with base64. For example, `echo "abc123" | base64 -` becomes `'YWJjMTIzCg=='` and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIzCg=='`.
3940

40-
### Source type
41+
## Source type
4142

4243
set up an `HTTP API` source type in Segment. You will use this source write key for authenticating with the Objects Bulk API.
4344

44-
### Limits
45+
## Limits
46+
4547
The API imposes some rate limits including:
4648
- **512MB** maximum uncompressed [file](#batched-object-data) upload size
4749
- **400KB** maximum [object](#batched-object-data) size

src/connections/sources/catalog/libraries/server/php/quickstart.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,6 @@ Segment::flush();
141141

142142
And presto, **you're done!** You successfully installed PHP tracking. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
143143

144-
---
145-
146-
147144
## What's Next?
148145

149146
We just walked through the quickest way to get started with Segment using PHP. You might also want to check out our full [PHP reference](/docs/connections/sources/catalog/libraries/server/php) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http) to get a sense for the bigger picture.

src/connections/sources/catalog/libraries/server/python/quickstart.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,6 @@ To get started, we recommend tracking just a few important events. You can alway
9797

9898
And voila, **you're done!** You've just successfully installed analytics tracking on your servers. Now you're ready to turn on any destination you fancy from our interface, martini in hand.
9999

100-
101-
---
102-
103-
104100
## What's Next?
105101

106102
We just walked through the quickest way to get started with Segment using Python. You might also want to check out our full [Python library reference](/docs/connections/sources/catalog/libraries/server/python/) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture.

0 commit comments

Comments
 (0)