Skip to main content
POST
/
projects
/
{projectId}
/
warehouse-sources
/
imports
/
lookup-table
Create a lookup table import
curl --request POST \
  --url https://{regionAndDomain}.com/api/app/projects/{projectId}/warehouse-sources/imports/lookup-table \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "import_type": "lookup_table",
  "warehouse_source_id": 123,
  "table_params": {},
  "mixpanel_property": {
    "value": "<string>",
    "customPropertyId": 123
  },
  "property_key_column_name": "<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": [
        {}
      ]
    }
  }
}
'
{
  "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:
lookup_table
​
warehouse_source_id
integer
required
​
table_params
object
required

Table location parameters (structure depends on warehouse type)

​
mixpanel_property
object
required

The Mixpanel property that this lookup table will be joined on. This defines the "Join Key" — the Mixpanel event or user property whose values will be matched against the property_key_column_name column in your warehouse table.

For example, if your events have a property called product_id and your warehouse lookup table has a column product_id containing matching values along with enrichment columns like product_name and category, you would set:

  • mixpanel_property.value = "product_id" (the Mixpanel property name)
  • property_key_column_name = "product_id" (the warehouse column name)
​
property_key_column_name
string
required

The name of the column in your warehouse table that contains the join key values. This column's values will be matched against the Mixpanel property specified in mixpanel_property.value to look up the corresponding row.

​
sync_mode
enum<string>
required
Available options:
full_sync,
one_time
​
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
​
databricks_params
object

Response

Success

​
status
enum<string>

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

Available options:
ok
Example:

"ok"

​
results
object