Skip to main content
PATCH
/
console
/
v1
/
experiments
/
entity_property
/
{name}
Patch Entity Property Source
curl --request PATCH \
  --url https://statsigapi.net/console/v1/experiments/entity_property/{name} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "timestampColumn": "<string>",
  "timestampAsDay": true,
  "idTypeMapping": [
    {
      "statsigUnitID": "<string>",
      "column": "<string>"
    }
  ],
  "isReadOnly": true,
  "team": "<string>",
  "teamID": "<string>",
  "dryRun": true
}'
{
  "message": "Entity Property Source updated successfully",
  "data": {
    "name": "Location",
    "description": "This is the the 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.

Path Parameters

name
string
required

Name of entity property source

Body

application/json
name
string

Unique identifier for the entity property source.

description
string

Detailed context and purpose of the entity property source.

tags
string[]

Tags for categorization and search.

timestampColumn
string

Optional column name for timestamp.

timestampAsDay
boolean

Indicates if the timestamp is treated as a day.

idTypeMapping
object[]

Mappings of Statsig units to their columns.

isReadOnly
boolean

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

team
string | null

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

teamID
string | null

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

dryRun
boolean

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

Response

Patch Entity Property Source response

message
string
required

A simple string explaining the result of the operation.

data
object
required

A single result.

I