Import events
This type of pipeline imports events into the workspace's data warehouse received from websites, mobile apps, backend systems, and connected devices. It is available only for source SDK and webhook connections.
Create pipeline
Create a source pipeline that imports events into the data warehouse.
Request
-
name
string RequiredThe pipeline's name.
Must be a non-empty string with a maximum of 60 characters. -
connection
int RequiredThe ID of the connection from which the events are received. It must be an SDK or webhook connection.
-
target
string RequiredThe entity on which the pipeline operates, which must be
Possible values:"Event"in order to create a pipeline that imports events."Event". -
enabled
booleanIndicates if the pipeline is enabled once created.
-
filter
nullable objectThe filter applied to the events. If it's not null, only the events that match the filter will be imported.
See the filters documentation for more details.
-
filter.logical
string Required Possible values:"and"or"or". -
filter.conditions
array of object RequiredA filter's condition.
-
property
string RequiredThe name or path of the property. If the property has a
jsontype, it can include a json path. -
operator
string RequiredThe condition's operator. The allowed values depend on the property's type.
Possible values:"is","is not","is less than","is less than or equal to","is greater than","is greater than or equal to","is between","is not between","contains","does not contain","is one of","is not one of","starts with","ends with","is before","is on or before","is after","is on or after","is true","is false","is empty","is not empty","is null","is not null","exists"or"does not exist". -
values
array of stringThe values the operator applies to, if any. These depend on both the operator and the property's type, including whether they're present and how many there are.
-
-
Response
-
id
intThe ID of the pipeline.
POST /v1/pipelines
curl https://example.com/v1/pipelines \ -H "Authorization: Bearer api_xxxxxxx" \ --json '{ "name": "Collect track events", "connection": 230527183, "target": "Event", "enabled": true, "filter": { "logical": "and", "conditions": [ { "property": "type", "operator": "is", "values": [ "track" ] } ] } }' Response
{
"id": 705981339
}Errors
404
workspace does not exist
422
connection does not exist
422
connector does not exist
Update pipeline
Update a source pipeline that imports events into the data warehouse.
Request
-
:id
int RequiredThe ID of the source event pipeline.
-
name
string RequiredThe pipeline's name.
Must be a non-empty string with a maximum of 60 characters. -
enabled
booleanIndicates if the pipeline is enabled. Use the Set status endpoint to change only the pipeline's status.
-
filter
nullable objectThe filter applied to the events. If it's not null, only the events that match the filter will be imported.
See the filters documentation for more details.
-
filter.logical
string Required Possible values:"and"or"or". -
filter.conditions
array of object RequiredA filter's condition.
-
property
string RequiredThe name or path of the property. If the property has a
jsontype, it can include a json path. -
operator
string RequiredThe condition's operator. The allowed values depend on the property's type.
Possible values:"is","is not","is less than","is less than or equal to","is greater than","is greater than or equal to","is between","is not between","contains","does not contain","is one of","is not one of","starts with","ends with","is before","is on or before","is after","is on or after","is true","is false","is empty","is not empty","is null","is not null","exists"or"does not exist". -
values
array of stringThe values the operator applies to, if any. These depend on both the operator and the property's type, including whether they're present and how many there are.
-
-
Response
No response.PUT /v1/pipelines/:id
curl -X PUT https://example.com/v1/pipelines/705981339 \ -H "Authorization: Bearer api_xxxxxxx" \ --json '{ "name": "Collect track events", "enabled": true, "filter": { "logical": "and", "conditions": [ { "property": "type", "operator": "is", "values": [ "track" ] } ] } }' Errors
404
workspace does not exist
404
pipeline does not exist
Get pipeline
Get a source pipeline that imports events into the data warehouse.
Request
-
:id
int RequiredThe ID of the source event pipeline.
Response
-
id
intThe ID of the source event pipeline.
-
name
stringThe pipeline's name.
It is not longer than 60 characters. -
connector
stringThe code of the connection's connector.
-
connectorType
stringThe type of the connection's connector. It is always
Possible values:"SDK"or"Webhook"when the pipeline imports events."Application","Database","FileStorage","MessageBroker","SDK"or"Webhook". -
connection
intThe ID of the connection from which the events are received. It is a source SDK or webhook connection.
-
connectionRole
stringThe role of the pipeline's connection. It is always
Possible values:"Source"when the pipeline imports events."Source"or"Destination". -
target
stringThe entity on which the pipeline operates. It is always
Possible values:"Event"when the pipeline imports events."User"or"Event". -
enabled
booleanIndicates if the pipeline is enabled.
-
filter
nullable objectThe filter applied to the events. If it's not null, only the events that match the filter will be imported.
See the filters documentation for more details.
-
filter.logical
string Possible values:"and"or"or". -
filter.conditions
array of objectA filter's condition.
-
property
stringThe name or path of the property. If the property has a
jsontype, it can include a json path. -
operator
stringThe condition's operator. The allowed values depend on the property's type.
Possible values:"is","is not","is less than","is less than or equal to","is greater than","is greater than or equal to","is between","is not between","contains","does not contain","is one of","is not one of","starts with","ends with","is before","is on or before","is after","is on or after","is true","is false","is empty","is not empty","is null","is not null","exists"or"does not exist". -
values
array of stringThe values the operator applies to, if any. These depend on both the operator and the property's type, including whether they're present and how many there are.
-
-
-
inSchema
schemaThe input schema. When importing events, it is the event schema.
GET /v1/pipelines/:id
curl https://example.com/v1/pipelines/705981339 \ -H "Authorization: Bearer api_xxxxxxx" Response
{
"id": 705981339,
"name": "Collect track events",
"connector": "android",
"connectorType": "SDK",
"connection": 1371036433,
"connectionRole": "Source",
"target": "Event",
"enabled": true,
"filter": {
"logical": "and",
"conditions": [
{
"property": "type",
"operator": "is",
"values": [
"track"
]
}
]
},
"inSchema": {
"kind": "object",
"properties": [
{
"name": "connectionId",
"type": {
"kind": "int",
"bitSize": 32
},
"description": "Connection ID"
},
{
"name": "anonymousId",
"type": {
"kind": "string"
},
"description": "Anonymous ID"
},
{
"name": "channel",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Channel"
},
{
"name": "category",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Category"
},
{
"name": "context",
"type": {
"kind": "object",
"properties": [
{
"name": "app",
"type": {
"kind": "object",
"properties": [
{
"name": "name",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Name"
},
{
"name": "version",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Version"
},
{
"name": "build",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Build"
},
{
"name": "namespace",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Namespace"
}
]
},
"readOptional": true,
"description": "App"
},
{
"name": "browser",
"type": {
"kind": "object",
"properties": [
{
"name": "name",
"type": {
"kind": "string",
"values": [
"Chrome",
"Safari",
"Edge",
"Firefox",
"Samsung Internet",
"Opera",
"Other"
]
},
"readOptional": true,
"description": "Name"
},
{
"name": "other",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Other"
},
{
"name": "version",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Version"
}
]
},
"readOptional": true,
"description": "Browser"
},
{
"name": "campaign",
"type": {
"kind": "object",
"properties": [
{
"name": "name",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Name"
},
{
"name": "source",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Source"
},
{
"name": "medium",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Medium"
},
{
"name": "term",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Term"
},
{
"name": "content",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Content"
}
]
},
"readOptional": true,
"description": "Campaign"
},
{
"name": "device",
"type": {
"kind": "object",
"properties": [
{
"name": "id",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Id"
},
{
"name": "advertisingId",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Advertising ID"
},
{
"name": "adTrackingEnabled",
"type": {
"kind": "boolean"
},
"readOptional": true,
"description": "Ad tracking enabled"
},
{
"name": "manufacturer",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Manufacturer"
},
{
"name": "model",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Model"
},
{
"name": "name",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Name"
},
{
"name": "type",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Type"
},
{
"name": "token",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Token"
}
]
},
"readOptional": true,
"description": "Device"
},
{
"name": "ip",
"type": {
"kind": "ip"
},
"readOptional": true,
"description": "IP"
},
{
"name": "library",
"type": {
"kind": "object",
"properties": [
{
"name": "name",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Name"
},
{
"name": "version",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Version"
}
]
},
"readOptional": true,
"description": "Library"
},
{
"name": "locale",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Locale"
},
{
"name": "location",
"type": {
"kind": "object",
"properties": [
{
"name": "city",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "City"
},
{
"name": "country",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Country"
},
{
"name": "latitude",
"type": {
"kind": "float",
"bitSize": 64
},
"readOptional": true,
"description": "Latitude"
},
{
"name": "longitude",
"type": {
"kind": "float",
"bitSize": 64
},
"readOptional": true,
"description": "Longitude"
},
{
"name": "speed",
"type": {
"kind": "float",
"bitSize": 64
},
"readOptional": true,
"description": "Speed"
}
]
},
"readOptional": true,
"description": "Location"
},
{
"name": "network",
"type": {
"kind": "object",
"properties": [
{
"name": "bluetooth",
"type": {
"kind": "boolean"
},
"readOptional": true,
"description": "Bluetooth"
},
{
"name": "carrier",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Carrier"
},
{
"name": "cellular",
"type": {
"kind": "boolean"
},
"readOptional": true,
"description": "Cellular"
},
{
"name": "wifi",
"type": {
"kind": "boolean"
},
"readOptional": true,
"description": "Wi-Fi"
}
]
},
"readOptional": true,
"description": "Network"
},
{
"name": "os",
"type": {
"kind": "object",
"properties": [
{
"name": "name",
"type": {
"kind": "string",
"values": [
"Android",
"Windows",
"iOS",
"macOS",
"Linux",
"Chrome OS",
"Other"
]
},
"readOptional": true,
"description": "Name"
},
{
"name": "other",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Other"
},
{
"name": "version",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Version"
}
]
},
"readOptional": true,
"description": "OS"
},
{
"name": "page",
"type": {
"kind": "object",
"properties": [
{
"name": "path",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Path"
},
{
"name": "referrer",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Referrer"
},
{
"name": "search",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Search"
},
{
"name": "title",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Title"
},
{
"name": "url",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "URL"
}
]
},
"readOptional": true,
"description": "Page"
},
{
"name": "referrer",
"type": {
"kind": "object",
"properties": [
{
"name": "id",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "ID"
},
{
"name": "type",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Type"
}
]
},
"readOptional": true,
"description": "Referrer"
},
{
"name": "screen",
"type": {
"kind": "object",
"properties": [
{
"name": "width",
"type": {
"kind": "int",
"bitSize": 16
},
"readOptional": true,
"description": "Width"
},
{
"name": "height",
"type": {
"kind": "int",
"bitSize": 16
},
"readOptional": true,
"description": "Height"
},
{
"name": "density",
"type": {
"kind": "decimal",
"precision": 3,
"scale": 2
},
"readOptional": true,
"description": "Density"
}
]
},
"readOptional": true,
"description": "Screen"
},
{
"name": "session",
"type": {
"kind": "object",
"properties": [
{
"name": "id",
"type": {
"kind": "int",
"bitSize": 64
},
"readOptional": true,
"description": "ID"
},
{
"name": "start",
"type": {
"kind": "boolean"
},
"readOptional": true,
"description": "Start"
}
]
},
"readOptional": true,
"description": "Session"
},
{
"name": "timezone",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Timezone"
},
{
"name": "userAgent",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "User agent"
}
]
},
"readOptional": true,
"description": "Context"
},
{
"name": "event",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Event"
},
{
"name": "groupId",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Group ID"
},
{
"name": "messageId",
"type": {
"kind": "string"
},
"description": "Message ID"
},
{
"name": "name",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Name"
},
{
"name": "properties",
"type": {
"kind": "json"
},
"readOptional": true,
"description": "Properties"
},
{
"name": "receivedAt",
"type": {
"kind": "datetime"
},
"description": "Received at"
},
{
"name": "sentAt",
"type": {
"kind": "datetime"
},
"description": "Sent at"
},
{
"name": "originalTimestamp",
"type": {
"kind": "datetime"
},
"description": "Original timestamp"
},
{
"name": "timestamp",
"type": {
"kind": "datetime"
},
"description": "Timestamp"
},
{
"name": "traits",
"type": {
"kind": "json"
},
"description": "Traits"
},
{
"name": "type",
"type": {
"kind": "string",
"values": [
"alias",
"identify",
"group",
"page",
"screen",
"track"
]
},
"description": "Type"
},
{
"name": "previousId",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "Previous ID"
},
{
"name": "userId",
"type": {
"kind": "string"
},
"readOptional": true,
"description": "User ID"
}
]
}
}Errors
404
workspace does not exist
404
pipeline does not exist