Create Metric Source

POST /console/v1/metrics/metric_source

Create Metric Source

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/metrics/metric_source \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "sql": "<string>",
  "timestampColumn": "<string>",
  "idTypeMapping": [
    {
      "statsigUnitID": "<string>",
      "column": "<string>"
    }
  ],
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "timestampAsDay": true,
  "tableName": "<string>",
  "customFieldMapping": [
    {
      "key": "<string>",
      "formula": "<string>"
    }
  ],
  "isReadOnly": true,
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "[e-mail]"
  },
  "dryRun": true
}
'

201

{
  "message": "Metric source created successfully.",
  "data": {
    "name": "test_metric_source2",
    "description": "Test description for metric source",
    "tags": [
      "non_production"
    ],
    "sql": "SELECT * FROM `shoppy-sales.logging.events`",
    "timestampColumn": "ts",
    "timestampAsDay": true,
    "idTypeMapping": [
      {
        "statsigUnitID": "userID",
        "column": "user_id"
      }
    ],
    "sourceType": "table",
    "tableName": "shoppy-sales.logging.events"
  }
}

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

name · string · required

The name of the metric source, serving as its primary identifier.

sql · string · required

The SQL query or statement used to extract data from the metric source.

timestampColumn · string · required

The name of the column containing timestamp data for the metric source.

idTypeMapping · object[] · required

Array defining the mapping between Statsig unit IDs and their respective source columns.

Show child attributes

description · string

An optional description for the metric source, providing context and details about its purpose and usage.

tags · string[]

Optional array of tags to categorize the metric source, facilitating easier organization and retrieval.

timestampAsDay · boolean

Indicates whether the timestamp should be treated as a day-level granularity.

sourceType · enum<string>

The type of source, indicating whether it is a database table or a custom query.

Available options: table, query

tableName · string

The name of the database table if the source type is "table".

customFieldMapping · object[]

Optional array defining mappings for custom fields using specific formulas.

Show child attributes

isReadOnly · boolean

Specifies if the source can only be edited via the Console API.

owner · object | null

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

dryRun · boolean

Skips persisting the metric source (used to validate that inputs are correct)

Response

201

application/json

Create metric source response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes