Patch Entity Property Source

patchhttps://statsigapi.net/console/v1/experiments/entity_property/{name}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

namestringrequired

Name of entity property source

Body

application/json
namestring

Unique identifier for the entity property source.

descriptionstring

Detailed context and purpose of the entity property source.

tagsstring[]

Tags for categorization and search.

sqlunknown

SQL query defining the data source

timestampColumnstring

Optional column name for timestamp.

timestampAsDayboolean

Indicates if the timestamp is treated as a day.

idTypeMappingobject[]

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
200Patch 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

Was this helpful?