List qualifying event

gethttps://statsigapi.net/console/v1/experiments/qualifying_events

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

Response

application/json
200List metric source response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
name[]stringrequired

The name of the source, serving as its primary identifier.

description[]stringrequired

A detailed description of the source, providing context and usage information.

tags[]string[]

Optional tags for categorizing the source and improving searchability.

sql[]stringrequired

The SQL query or statement used to extract data from the source.

timestampColumn[]stringrequired

The name of the column containing timestamp data for the source.

timestampAsDay[]boolean

Indicates whether the timestamp should be treated as a day-level granularity.

idTypeMapping[]object[]required

Array defining the mapping between Statsig unit IDs and their respective source columns.

Show child attributes
statsigUnitID[]stringrequired

The identifier mapping for Statsig units.

column[]stringrequired

The corresponding column name in the source that relates to the Statsig unit ID.

sourceType[]string

The type of source, indicating whether it is a database table or a custom query.

tableName[]string

The name of the database table if the source type is "table".

datePartitionColumn[]string

The name of the date partition column if the source type is "table". Can be undefined.

customFieldMapping[]object[]

Optional array defining mappings for custom fields using specific formulas.

Show child attributes
key[]stringrequired

The identifier for the custom field mapping.

formula[]stringrequired

The formula or expression used to compute the custom field value.

isReadOnly[]boolean

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

isVerified[]boolean

Marks the metric source as verified, indicating trustworthiness within the organization.

disableCURE[]boolean

Disable CURE for all metrics built from this metric source

owner[]object

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

Show child attributes
ownerIDstring

ID of the owner

ownerTypestring

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

ownerNamestring

The name of the owner. This field is optional.

ownerEmailstring

The email of the owner. This field is optional.

team[]string

Optional field indicating the team name responsible for the metric, aiding in accountability and management.

teamID[]string

Optional field indicating the team ID responsible for the metric, aiding in accountability and management.

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

400Invalid request. Please check the request input and try again.
statusintegerrequired
messagestringrequired
401This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
messagestringrequired

Was this helpful?