Read Metric Source

GET /console/v1/metrics/metric_source/{name}

Try it

Read Metric Source

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/metrics/metric_source/{name} \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Metric source read successfully.",
  "data": {
    "name": "test_metric_source4",
    "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.

Path Parameters

name · string · required

name

Response

200

application/json

Read metric source response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. name · string · required

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

data. description · string · required

A detailed description of the metric source, providing context and usage information.

data. sql · string · required

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

data. timestampColumn · string · required

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

data. idTypeMapping · object[] · required

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

Show child attributes

data.idTypeMapping. statsigUnitID · string · required

The identifier mapping for Statsig units.

data.idTypeMapping. column · string · required

The corresponding column name in the source that relates to the Statsig unit ID.

data. tags · string[]

Optional tags for categorizing the metric source and improving searchability.

data. timestampAsDay · boolean

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

data. sourceType · enum<string>

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

Available options: table, query

data. tableName · string

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

data. customFieldMapping · object[]

Optional array defining mappings for custom fields using specific formulas.

Show child attributes

data.customFieldMapping. key · string · required

The identifier for the custom field mapping.

data.customFieldMapping. formula · string · required

The formula or expression used to compute the custom field value.

data. isReadOnly · boolean

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

data. owner · object

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

Show child attributes

data.owner. ownerID · string

ID of the owner

Example:

"abc123"

data.owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

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