Skip to main content
POST
/
console
/
v1
/
experiments
/
entity_properties
Create Entity Property Source
curl --request POST \
  --url https://statsigapi.net/console/v1/experiments/entity_properties \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "sql": "<string>",
  "idTypeMapping": [
    {
      "statsigUnitID": "<string>",
      "column": "<string>"
    }
  ],
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "timestampColumn": "<string>",
  "timestampAsDay": true,
  "isReadOnly": true,
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "owner123@test.com"
  }
}
'
{
  "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
  }
}

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

Unique identifier for the entity property source.

​
sql
string
required

SQL query defining the data source.

​
idTypeMapping
object[]
required

Mappings of Statsig units to their columns.

​
description
string

Optional detailed context for the entity property source.

​
tags
string[]

Optional tags for categorization.

​
timestampColumn
string

Optional column name for timestamp.

​
timestampAsDay
boolean

Indicates if the timestamp is treated as a day.

​
isReadOnly
boolean

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

​
owner
object

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

Example:
{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "owner123@test.com"
}

Response

Create Entity Property Source response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.