Create Ingestion Source

POST /console/v1/ingestion

Try it

Create Ingestion Source

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/ingestion \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "dataset": "Metrics",
  "type": "redshift",
  "source_name": "<string>",
  "column_mapping": {
    "unit_id": "<string>",
    "id_type": "<string>",
    "dateid": "<string>",
    "metric_name": "<string>",
    "metric_value": "null",
    "numerator": "null",
    "denominator": "null"
  },
  "query": "<string>",
  "use_delta_sharing": true,
  "share": "<string>",
  "schema": "<string>",
  "table": "<string>",
  "enabled": true
}
'

200

{
  "type": "databricks",
  "dataset": "Metrics",
  "source_name": "ingestion-1",
  "query": "SELECT * FROM TABLE",
  "column_mapping": {
    "unit_id": "string",
    "id_type": "string",
    "dateid": "string",
    "metric_name": "string",
    "metric_value": "string",
    "numerator": "string",
    "denominator": "string"
  },
  "use_delta_sharing": false,
  "share": "string",
  "schema": "string",
  "table": "string",
  "enabled": false
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Body

application/json

Option 1

dataset · enum<string> · required

Available options: Metrics

type · enum<string> · required

Available options: redshift, bigquery-v2, snowflake-v2, databricks, azure-synapse, s3, athena, adls

source_name · string · required

column_mapping · object

Show child attributes

column_mapping. unit_id · string · required

The unique user identifier this metric is for. This might not necessarily be a user_id - it could be a custom_id of some kind. Make sure this is in the same format as your logged unit_ids.

column_mapping. id_type · string · required

The id_type the unit_id represents. Must be valid id_type. Default Statsig types are user_id/stable_id, but you may have generated custom id_types. Make sure this matches (case sensitive) a customID in your project, or you won’t get experiment results.

column_mapping. dateid · string · required

Date of the daily metric, ISO formatted (ex. 2021-02-17). We’ll load custom metrics to whatever date you use here.

column_mapping. metric_name · string · required

String format. Not null. Length < 128 characters.

column_mapping. metric_value · string · default: null

Numeric value for the metric. This OR both of numerator and denominator need to be provided.

column_mapping. numerator · string · default: null

Required for ratio metrics. If present along with a denominator in any record, the metric will be treated as ratio and only calculated for users with non-null denominators

column_mapping. denominator · string · default: null

Required for ratio metrics. If present along with a numerator in any record, the metric will be treated as ratio and only calculated for users with non-null numerators.

query · string

use_delta_sharing · enum<boolean>

Available options: true, false

share · string

schema · string

table · string

enabled · boolean

Response

200 - application/json

Create Ingestion Success

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. id · string · required

data. type · string · required

data. enabled · boolean · required

data. data · object · required