Create Entity Property Source

post/console/v1/experiments/entity_properties

Request

Base URL
https://statsigapi.net
URL
https://statsigapi.net/console/v1/experiments/entity_properties
Auth
API key in header STATSIG-API-KEY

Request body

namestring required

Unique identifier for the entity property source.

descriptionstring

Optional detailed context for the entity property source.

tagsstring[]

Optional tags for categorization.

sqlstring required

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

Create Entity Property Source response

messagestring required

A simple string explaining the result of the operation.

Example 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
  }
}

Changes

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