Get Entity Property Source

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

Response

200

application/json

Get Entity Property Source response

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

data.name

string

required

Unique identifier for the entity property source.

data.description

string

required

Detailed context and purpose of the entity property source.

data.tags

string[]

required

Tags for categorization and search.

data.sql

string

required

SQL query defining the data source.

data.idTypeMapping

object[]

required

Mappings of Statsig units to their columns.

Show child attributes

data.idTypeMapping.statsigUnitID

string

required

ID for the Statsig unit.

data.idTypeMapping.column

string

required

Column name linked to the ID.

data.timestampColumn

string

Optional column name for timestamp.

data.timestampAsDay

boolean

Indicates if the timestamp is treated as a day.

data.isReadOnly

boolean

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

data.owner

object | null

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

Show child attributes

data.owner.ownerID

string

ID of the owner

Example:

"abc123"

data.owner.ownerType

string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner.ownerName

string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner.ownerEmail

string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}