Create Entity Property Source

posthttps://statsigapi.net/console/v1/experiments/entity_properties

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Body

application/json

namestringrequired

Unique identifier for the entity property source.

descriptionstring

Optional detailed context for the entity property source.

tagsstring[]

Optional tags for categorization.

sqlstringrequired

SQL query defining the data source.

timestampColumnstring

Optional column name for timestamp.

timestampAsDayboolean

Indicates if the timestamp is treated as a day.

idTypeMappingobject[]required

Mappings of Statsig units to their columns.

Show child attributes

statsigUnitID[]stringrequired

ID for the Statsig unit.

column[]stringrequired

Column name linked to the ID.

isReadOnlyboolean

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

teamstring

Optional field indicating the team name responsible for the metric, aiding in accountability and management.

teamIDstring

Optional field indicating the team ID responsible for the metric, aiding in accountability and management.

dryRunboolean

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

Response

application/json

201Create Entity Property Source response

messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Show child attributes

namestringrequired

Unique identifier for the entity property source.

descriptionstringrequired

Detailed context and purpose of the entity property source.

tagsstring[]required

Tags for categorization and search.

sqlstringrequired

SQL query defining the data source.

timestampColumnstring

Optional column name for timestamp.

timestampAsDayboolean

Indicates if the timestamp is treated as a day.

idTypeMappingobject[]required

Mappings of Statsig units to their columns.

Show child attributes

statsigUnitID[]stringrequired

ID for the Statsig unit.

column[]stringrequired

Column name linked to the ID.

isReadOnlyboolean

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

ownerobject

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

Show child attributes

ownerIDstring

ID of the owner

ownerTypestring

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

ownerNamestring

The name of the owner. This field is optional.

ownerEmailstring

The email of the owner. This field is optional.

teamstring

Optional field indicating the team name responsible for the metric, aiding in accountability and management.

teamIDstring

Optional field indicating the team ID responsible for the metric, aiding in accountability and management.

400Invalid request. Please check the request input and try again.

statusintegerrequired

messagestringrequired

401This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx

statusintegerrequired

messagestringrequired

404Not Found. The requested resource could not be found.

statusintegerrequired

messagestringrequired

Create Entity Property Source

curl -X POST "https://statsigapi.net/console/v1/experiments/entity_properties" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Response

{
  "message": "Entity Property Source created successfully",
  "data": {
    "name": "Location",
    "description": "",
    "tags": [],
    "sql": "SELECT * FROM shoppy-sales.setup.user_properties",
    "timestampColumn": "timestamp",
    "idTypeMapping": [
      {
        "statsigUnitID": "stableID",
        "column": "user_id"
      }
    ],
    "timestampAsDay": true
  }
}

Was this helpful?