Patch Entity Property Source

patch/console/v1/experiments/entity_property/{name}

Request

Base URL
https://statsigapi.net
URL
https://statsigapi.net/console/v1/experiments/entity_property/{name}
Auth
API key in header STATSIG-API-KEY

Path parameters

namestring required

Name of entity property source

Request body

namestring

Unique identifier for the entity property source.

descriptionstring

Detailed context and purpose of the entity property source.

tagsstring[]

Tags for categorization and search.

sqlstring

SQL query defining the data source

timestampColumnstring

Optional column name for timestamp.

timestampAsDayboolean

Indicates if the timestamp is treated as a day.

isReadOnlyboolean

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

teamstring nullable

Optional field indicating the team name responsible for the entity property source, aiding in accountability and management.

teamIDstring nullable

Optional field indicating the team ID responsible for the entity property source, aiding in accountability and management.

dryRunboolean

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

Response

Patch Entity Property Source response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 41 revisions of this API.