Warehouse Imports

Create Event Stream Import

Create a new warehouse import for event data.

Event stream imports sync event data from your warehouse table to Mixpanel. Each row in your table becomes an event in Mixpanel.

Sync Modes

time_based: Incrementally syncs new rows based on an insert time column
mirror_mode: Detects changes in the source table and mirrors them to Mixpanel
full_sync: Re-syncs all data on each run
one_time: Syncs data once and does not repeat

Required Column Mappings

You must specify either:

event_name: A static event name for all rows
event_column_name: The column containing the event name

For B2B projects, company_column_name is also required.

Scheduling

run_every (integer): Sync frequency in nanoseconds. Allowed values:
- Trigger via API: 0
- Hourly: 3600000000000 (60 * 60 * 10^9)
- Daily: 86400000000000 (24 * 60 * 60 * 10^9)
- Weekly: 604800000000000 (7 * 24 * 60 * 60 * 10^9)
databricks_params (object): Databricks-specific cluster configuration (only for Databricks sources)

POST

projects

{projectId}

warehouse-sources

imports

event-stream

Create an event stream import

curl --request POST \
  --url https://{regionAndDomain}.com/api/app/projects/{projectId}/warehouse-sources/imports/event-stream \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "import_type": "event_stream",
  "warehouse_source_id": 123,
  "table_params": {},
  "time_column_name": "<string>",
  "event_name": "<string>",
  "event_column_name": "<string>",
  "user_column_name": "<string>",
  "company_column_name": "<string>",
  "device_column_name": "<string>",
  "json_properties_column_name": "<string>",
  "insert_time_column_name": "<string>",
  "property_mappings": {},
  "databricks_params": {
    "export_cluster_config": {
      "spark_version": "<string>",
      "node_type_id": "<string>",
      "driver_node_type_id": "<string>",
      "num_workers": 1,
      "autoscale": {
        "min_workers": 1,
        "max_workers": 2
      },
      "spark_conf": {},
      "spark_env_vars": {},
      "single_user_name": "<string>",
      "custom_tags": {},
      "policy_id": "<string>",
      "instance_pool_id": "<string>",
      "driver_instance_pool_id": "<string>",
      "enable_elastic_disk": true,
      "aws_attributes": {},
      "azure_attributes": {},
      "gcp_attributes": {},
      "init_scripts": [
        {}
      ]
    }
  }
}
'

{
  "status": "ok",
  "results": {
    "id": 123,
    "created": "2023-11-07T05:31:56Z",
    "creator_id": 123,
    "creator_name": "<string>",
    "creator_email": "<string>",
    "warehouse_source_id": 123,
    "table_params": {},
    "paused": true,
    "last_dispatch": 123,
    "is_deleted": true,
    "event_name": "<string>",
    "event_column_name": "<string>",
    "time_column_name": "<string>",
    "user_column_name": "<string>",
    "insert_time_column_name": "<string>",
    "property_mappings": {},
    "group_key": "<string>",
    "group_id_column": "<string>",
    "databricks_params": {
      "export_cluster_config": {
        "spark_version": "<string>",
        "node_type_id": "<string>",
        "driver_node_type_id": "<string>",
        "num_workers": 1,
        "autoscale": {
          "min_workers": 1,
          "max_workers": 2
        },
        "spark_conf": {},
        "spark_env_vars": {},
        "single_user_name": "<string>",
        "custom_tags": {},
        "policy_id": "<string>",
        "instance_pool_id": "<string>",
        "driver_instance_pool_id": "<string>",
        "enable_elastic_disk": true,
        "aws_attributes": {},
        "azure_attributes": {},
        "gcp_attributes": {},
        "init_scripts": [
          {}
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Service Account

Path Parameters

projectId

integer

required

Your project id (eg: 12345)

Body

application/json

import_type

enum<string>

required

Available options:

event_stream

warehouse_source_id

integer

required

table_params

object

required

Table location parameters (structure depends on warehouse type)

time_column_name

string

required

sync_mode

enum<string>

required

Available options:

time_based,

mirror_mode,

full_sync,

one_time

event_name

string

event_column_name

string

user_column_name

string

company_column_name

string

Required for B2B projects. The column containing the company identifier.

device_column_name

string | null

json_properties_column_name

string | null

run_every

enum<integer>

Sync frequency in nanoseconds. Only these values are accepted:

0 - API-triggered only (use the manual-sync endpoint to trigger)
3600000000000 - Hourly
86400000000000 - Daily
604800000000000 - Weekly

Available options:

0,

3600000000000,

86400000000000,

604800000000000

insert_time_column_name

string | null

property_mappings

object

Show child attributes

databricks_params

object

Show child attributes

Response

Success

status

enum<string>

"ok" if the request succeeded, "error" otherwise.

Available options:

ok

Example:

"ok"

results

object

Show child attributes

Delete Warehouse Import

Create People Import

⌘I

Create an event stream import

curl --request POST \
  --url https://{regionAndDomain}.com/api/app/projects/{projectId}/warehouse-sources/imports/event-stream \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "import_type": "event_stream",
  "warehouse_source_id": 123,
  "table_params": {},
  "time_column_name": "<string>",
  "event_name": "<string>",
  "event_column_name": "<string>",
  "user_column_name": "<string>",
  "company_column_name": "<string>",
  "device_column_name": "<string>",
  "json_properties_column_name": "<string>",
  "insert_time_column_name": "<string>",
  "property_mappings": {},
  "databricks_params": {
    "export_cluster_config": {
      "spark_version": "<string>",
      "node_type_id": "<string>",
      "driver_node_type_id": "<string>",
      "num_workers": 1,
      "autoscale": {
        "min_workers": 1,
        "max_workers": 2
      },
      "spark_conf": {},
      "spark_env_vars": {},
      "single_user_name": "<string>",
      "custom_tags": {},
      "policy_id": "<string>",
      "instance_pool_id": "<string>",
      "driver_instance_pool_id": "<string>",
      "enable_elastic_disk": true,
      "aws_attributes": {},
      "azure_attributes": {},
      "gcp_attributes": {},
      "init_scripts": [
        {}
      ]
    }
  }
}
'

{
  "status": "ok",
  "results": {
    "id": 123,
    "created": "2023-11-07T05:31:56Z",
    "creator_id": 123,
    "creator_name": "<string>",
    "creator_email": "<string>",
    "warehouse_source_id": 123,
    "table_params": {},
    "paused": true,
    "last_dispatch": 123,
    "is_deleted": true,
    "event_name": "<string>",
    "event_column_name": "<string>",
    "time_column_name": "<string>",
    "user_column_name": "<string>",
    "insert_time_column_name": "<string>",
    "property_mappings": {},
    "group_key": "<string>",
    "group_id_column": "<string>",
    "databricks_params": {
      "export_cluster_config": {
        "spark_version": "<string>",
        "node_type_id": "<string>",
        "driver_node_type_id": "<string>",
        "num_workers": 1,
        "autoscale": {
          "min_workers": 1,
          "max_workers": 2
        },
        "spark_conf": {},
        "spark_env_vars": {},
        "single_user_name": "<string>",
        "custom_tags": {},
        "policy_id": "<string>",
        "instance_pool_id": "<string>",
        "driver_instance_pool_id": "<string>",
        "enable_elastic_disk": true,
        "aws_attributes": {},
        "azure_attributes": {},
        "gcp_attributes": {},
        "init_scripts": [
          {}
        ]
      }
    }
  }
}