Skip to main content

​
Required fields

  • timestamp date at which the event occurred. It follows the ISO 8601 format.
  • event_type name of the event. It can be anything and will be used when configuring your products
  • customer_id
  • record/id a unique ID for this event. If you send another event with the same ID, it will overwrite the previous one.

​
Your fields

You can add as many fields as you want. All of your fields should be prefixed with record/. For example, if you want to create a field count, you should name it record/count.

​
Format your file

To write a well-formatted events CSV file, you should follow these guidelines:
  • Use a comma as the delimiter to separate fields.
  • Use double quotes to enclose fields that contain commas or line breaks.
  • Use a header row to describe the contents of each column.
  • Use a consistent date and time format, such as ISO 8601.
  • Use a consistent format for nested fields, such as record/id and record/amount.
  • All fields are mandatory, except for the record field, which can contain any number of nested fields.

​
Example

Here is an example of a well-formatted CSV file that follows these guidelines: (record/type and record/is_live are just examples, you don’t need them) 
timestamp,event_type,record/id,record/type,record/is_live,customer_id
"2023-11-07T13:59:40.536Z",api_call,1245,"paid",true,"cus_foXtwuyW7NsCH-"
"2023-11-07T13:59:40.536Z",api_call,1152,"to_pay",true,"cus_foXtwuyW7NsCH-"
"2023-11-07T13:59:40.536Z",api_call,8625,"pending",false,"cus_foXtwuyW7NsCH-"
"2023-10-18T15:53:24.772Z",api_call,9752,"closed",true,"cus_foXtwuyW7NsCH-"
"2023-10-18T15:53:24.772Z",api_call,7052,"open",true,"cus_foXtwuyW7NsCH-"
Note that: The record field contains nested fields, such as record/id, record/amount, and record/is_live.
  • The record/id field contains an integer value, so it does not need to be enclosed in quotes.
  • The record/type field contains a string value, so it needs to be enclosed in quotes.
  • The record/is_live field contains a boolean value, so it does not need to be enclosed in quotes.

​
Load your file

To get start, just go to the events explorer page in Hyperline.
To upload your CSV file, click on the Import events from CSV button at the top right corner of the page. This will open a modal where you can select your file. You can also download a template file by clicking on the Get the CSV template download button. This file contains the header row and an example event, which you can use as a starting point for your own events CSV file.
Once you have selected your file, click on the Import CSV file button to start the import process. If there are no errors or warnings, your events will be imported into Hyperline and will be available for analysis and visualization.