> ## Documentation Index
> Fetch the complete documentation index at: https://statsig-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# List Entity Property Sources
## OpenAPI
````yaml api-reference/statsig_openapi.json get /console/v1/experiments/entity_properties
openapi: 3.0.0
info:
title: Console API
description: >-
The "Console API" is the CRUD API for performing the actions offered on
console.statsig.com without needing to go through the web UI.
If you have any feature requests, drop on in to our [slack
channel](https://www.statsig.com/slack) and let us know.
Authorization
All requests must include the **STATSIG-API-KEY** field in the header. The
value should be a **Console API Key** which can be created in the Project
Settings on
[console.statsig.com/api_keys](https://console.statsig.com/api_keys)
Rate Limiting
Requests to the Console API are limited to ~ 100reqs / 10secs and ~
900reqs / 15 mins.
Keyboard Search
Use Ctrl/Cmd + K to search for specific endpoints.
version: 20240601.0.0
contact: {}
servers:
- url: https://statsigapi.net
security: []
tags: []
paths:
/console/v1/experiments/entity_properties:
get:
tags:
- Experiments (Warehouse Native)
summary: List Entity Property Sources
parameters:
- name: limit
required: false
in: query
description: Results per page
schema:
example: 10
oneOf:
- type: string
- type: number
type: integer
- name: page
required: false
in: query
description: Page number
schema:
example: 1
oneOf:
- type: string
- type: number
type: integer
- name: x-respect-review-settings
in: header
description: Optional header to respect review settings for mutation endpoints.
required: false
schema:
type: string
responses:
'200':
description: List Entity Property Sources response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginationResponseWithMessage'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/EntityPropertySourceDto'
example:
message: Entity Property Sourcess listed successfully.
data:
- name: Segmentation Models
description: ''
tags:
- ★ Core
- Growth
sql: |-
SELECT
user_id, ds, spend_segment
FROM shoppy-sales.setup.segments
timestampColumn: ds
timestampAsDay: true
idTypeMapping:
- statsigUnitID: userID
column: user_id
pagination:
itemsPerPage: 1
pageNumber: 1
totalItems: 5
nextPage: /console/v1/experiments/entity_properties?page=2&limit=1
previousPage: null
all: /console/v1/experiments/entity_properties
example:
message: Entity Property Sourcess listed successfully.
data:
- name: Segmentation Models
description: ''
tags:
- ★ Core
- Growth
sql: |-
SELECT
user_id, ds, spend_segment
FROM shoppy-sales.setup.segments
timestampColumn: ds
timestampAsDay: true
idTypeMapping:
- statsigUnitID: userID
column: user_id
pagination:
itemsPerPage: 1
pageNumber: 1
totalItems: 5
nextPage: /console/v1/experiments/entity_properties?page=2&limit=1
previousPage: null
all: /console/v1/experiments/entity_properties
'400':
description: Invalid request. Please check the request input and try again.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 400
message:
type: string
required:
- status
- message
examples:
Invalid Request:
value:
status: 400
message: >-
Invalid request. Please check the request input and try
again.
'401':
description: >-
This endpoint only accepts an active CONSOLE key, but an invalid key
was sent. Key: console-xxxXXXxxxXXXxxx
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 401
message:
type: string
required:
- status
- message
examples:
Invalid Endpoint:
value:
status: 401
message: >-
This endpoint only accepts an active CONSOLE key, but an
invalid key was sent. Key: console-xxxXXXxxxXXXxxx
security:
- STATSIG-API-KEY: []
components:
schemas:
PaginationResponseWithMessage:
type: object
properties:
message:
type: string
description: A simple string explaining the result of the operation.
data:
description: Array of results returned by pagination limit.
type: array
items:
type: object
pagination:
description: Pagination metadata for checking if there is next page for example.
allOf:
- $ref: '#/components/schemas/PaginationResponseMetadataDto'
required:
- message
- data
- pagination
EntityPropertySourceDto:
type: object
properties:
name:
type: string
description: Unique identifier for the entity property source.
description:
type: string
description: Detailed context and purpose of the entity property source.
tags:
type: array
items:
type: string
description: Tags for categorization and search.
sql:
type: string
description: SQL query defining the data source.
timestampColumn:
type: string
description: Optional column name for timestamp.
timestampAsDay:
type: boolean
description: Indicates if the timestamp is treated as a day.
idTypeMapping:
type: array
items:
type: object
properties:
statsigUnitID:
type: string
description: ID for the Statsig unit.
column:
type: string
description: Column name linked to the ID.
required:
- statsigUnitID
- column
description: Mappings of Statsig units to their columns.
isReadOnly:
type: boolean
description: Specifies if the source can only be edited via the Console API.
owner:
type: object
properties:
ownerID:
type: string
description: ID of the owner
example: abc123
ownerType:
type: string
description: Type of the owner (e.g., SDK_KEY or USER)
example: USER
ownerName:
type: string
description: The name of the owner. This field is optional.
example: John Doe
ownerEmail:
type: string
description: The email of the owner. This field is optional.
description: >-
Schema for owner data including ID, type, name. Note that if Entity
is created by CONSOLE API, owner will be undefined.
example:
ownerID: user123
ownerType: USER
ownerName: John Doe
ownerEmail: owner123@test.com
nullable: true
required:
- name
- description
- tags
- sql
- idTypeMapping
PaginationResponseMetadataDto:
type: object
properties:
itemsPerPage:
type: number
pageNumber:
type: number
nextPage:
type: string
nullable: true
previousPage:
type: string
nullable: true
totalItems:
type: number
all:
type: string
required:
- itemsPerPage
- pageNumber
- nextPage
- previousPage
securitySchemes:
STATSIG-API-KEY:
type: apiKey
name: STATSIG-API-KEY
in: header
````