You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/guides/how-to-guides/import-historical-data.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,18 @@ When transitioning over to Segment, customers commonly want to import historical
6
6
7
7
**Note:** Historical imports can only be done into destinations that can accept historical timestamped data. Most analytics tools like Mixpanel, Amplitude, or Kissmetrics can handle that type of data just fine. One common destination that doesn't accept historical data is Google Analytics, since their API cannot accept historical data.
8
8
9
-
Use any [server-side library](https://segment.com/docs/connections/sources/#server), which sends requests in batches to improve performance. Once you have data to import, follow the steps below:
9
+
## Method 1: Using a Custom Solution
10
+
11
+
### General Instructions
12
+
Use any [server-side library](/docs/connections/sources/#server), which sends requests in batches to improve performance. Once you have data to import, follow the steps below:
10
13
11
14
1. Export or collect the data to be imported.
12
15
13
16
Include timestamp data in your export if the data needs to appear in end tools in a historical reference. For instance, if you're importing emails and it's relevant to know when someone joined your email list, you may need to export the timestamp. **If no timestamp is specified when importing, the data will show a timestamp from the time the data was received**.
14
17
15
18
2. Decide which destinations need to receive the data.
16
19
17
-
**By default, data coming into Segment will be relayed to all destinations linked to a given source.** To limit data to specific destinations, the `integrations` object must be modified. With historical data, you often only want to send the data to a specific destination or into your data warehouse. For example, in [Node.js](https://segment.com/docs/connections/sources/catalog/libraries/server/node/#integrations) set the `integrations` object as follows.
20
+
**By default, data coming into Segment will be forwarded to all destinations connected to a given source.** To limit data to specific destinations, the `integrations` object must be modified. With historical data, you often only want to send the data to a specific destination or into your data warehouse. For example, in [Node.js](https://segment.com/docs/connections/sources/catalog/libraries/server/node/#integrations) set the `integrations` object as follows.
18
21
```js
19
22
analytics.track({
20
23
event:'Upgraded Membership',
@@ -25,7 +28,13 @@ Use any [server-side library](https://segment.com/docs/connections/sources/#ser
25
28
26
29
3. Once you've done that, you'll need to write an application or worker to send the data to Segment.
27
30
28
-
You will need to cycle through each set of data and map it to a Segment server-side library method or build an array matching the [HTTP Import API format](https://segment.com/docs/connections/sources/catalog/libraries/server/http/#import). **Note**, we recommend using a Segment library for this process, as they will set contextual message fields like `message_id` (used for deduping) and `sent_at` (used for correctly client clock skew) that our API will use to ensure correct behavior upon ingestion. The server-side libraries will automatically batch requests to optimize for performance and prevent linear request volume. This batching behavior is modifiable. Some of the libraries implement a configurable max queue size that may discard messages if you enqueue requests much faster than the client can flush them. We recommend overriding the max queue size parameter for the library to a high value you're comfortable you can remain under in your batch job.
31
+
You will need to cycle through each set of data and map it to a Segment server-side library method or build an array matching the [HTTP Import API format](/docs/connections/sources/catalog/libraries/server/http/#import).
32
+
33
+
**Tip**: Segment recommends using a Segment library forthisprocess, as they set contextual message fields like `message_id` (used for deduping) and `sent_at` (used for correctly client clock skew) that Segment's API uses to correct behavior upon ingestion.
34
+
35
+
**Tip**: The server-side libraries will automatically batch requests to optimize for performance and prevent linear request volume. This batching behavior is modifiable, and some of the underlying libraries implement a configurable max queue size that may discard messages if you enqueue requests much faster than the client can flush them. We recommend overriding the max queue size parameter for the library to a high value you're comfortable you can remain under in your batch job.
36
+
37
+
### Demo projects
29
38
30
39
One of Segment's Success Engineers wrote an alpha prototype Node.js app for importing data utilizing the HTTP API, which we've included below:
31
40
@@ -35,6 +44,13 @@ Additionally, one of Segment's Software Engineers developed a React App with mor
If a server-side library doesn'tmeetyourneeds, usetheSegment [bulkimportHTTPAPI](https://segment.com/docs/connections/sources/catalog/libraries/server/http/#import). **Note**, if you're using the HTTP API directly to replay data you've exported from Segment, we recommend removing the original `sent_at`, `message_id`, and `project_id` fields from the archived message before forwarding them to Segment.
39
-
40
47
[MarketLytics](http://marketlytics.com/){:target="_blank"} has documented their experience using the alpha prototype importer and offer some [helpful visuals and tips](http://marketlytics.com/blog/import-historic-data-to-segment){:target="_blank"}.
48
+
49
+
### Alternative solution
50
+
If a server-side library doesn'tmeetyourneeds, youcanusetheSegment [bulkimport HTTP API](/docs/connections/sources/catalog/libraries/server/http/#import) directly.
0 commit comments