> ## 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 metric source
## OpenAPI
````yaml api-reference/statsig_openapi.json get /console/v1/metrics/metric_source/list
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/metrics/metric_source/list:
get:
tags:
- Metrics (Warehouse Native)
summary: List metric source
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 metric source response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginationResponseWithMessage'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/MetricSourceContractDto'
example:
message: Metric sources listed successfully.
data:
- name: Log Events
description: >-
all app events including add to cart, purchase, page
view, checkout
tags: []
sql: >
SELECT *
FROM shoppy-sales.logging.events
where DATE(ts) between {statsig_start_date} and
{statsig_end_date}
timestampColumn: ts
timestampAsDay: false
idTypeMapping:
- statsigUnitID: userID
column: user_id
- statsigUnitID: deviceID
column: device_id
tableName: ''
customFieldMapping:
- key: ''
formula: ''
pagination:
itemsPerPage: 1
pageNumber: 1
totalItems: 14
nextPage: /console/v1/metrics/metric_source/list?page=2&limit=1
previousPage: null
all: /console/v1/metrics/metric_source/list
example:
message: Metric sources listed successfully.
data:
- name: Log Events
description: >-
all app events including add to cart, purchase, page view,
checkout
tags: []
sql: >
SELECT *
FROM shoppy-sales.logging.events
where DATE(ts) between {statsig_start_date} and
{statsig_end_date}
timestampColumn: ts
timestampAsDay: false
idTypeMapping:
- statsigUnitID: userID
column: user_id
- statsigUnitID: deviceID
column: device_id
tableName: ''
customFieldMapping:
- key: ''
formula: ''
pagination:
itemsPerPage: 1
pageNumber: 1
totalItems: 14
nextPage: /console/v1/metrics/metric_source/list?page=2&limit=1
previousPage: null
all: /console/v1/metrics/metric_source/list
'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
MetricSourceContractDto:
type: object
properties:
name:
type: string
description: The name of the metric source, serving as its primary identifier.
description:
type: string
description: >-
A detailed description of the metric source, providing context and
usage information.
tags:
type: array
items:
type: string
description: >-
Optional tags for categorizing the metric source and improving
searchability.
sql:
type: string
description: >-
The SQL query or statement used to extract data from the metric
source.
timestampColumn:
type: string
description: >-
The name of the column containing timestamp data for the metric
source.
timestampAsDay:
type: boolean
description: >-
Indicates whether the timestamp should be treated as a day-level
granularity.
idTypeMapping:
type: array
items:
type: object
properties:
statsigUnitID:
type: string
description: The identifier mapping for Statsig units.
column:
type: string
description: >-
The corresponding column name in the source that relates to
the Statsig unit ID.
required:
- statsigUnitID
- column
description: >-
Array defining the mapping between Statsig unit IDs and their
respective source columns.
sourceType:
type: string
enum:
- table
- query
description: >-
The type of source, indicating whether it is a database table or a
custom query.
tableName:
type: string
description: The name of the database table if the source type is "table".
customFieldMapping:
type: array
items:
type: object
properties:
key:
type: string
description: The identifier for the custom field mapping.
formula:
type: string
description: >-
The formula or expression used to compute the custom field
value.
required:
- key
- formula
description: >-
Optional array defining mappings for custom fields using specific
formulas.
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
- sql
- timestampColumn
- 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
````