Skip to main content
GET
/
console
/
v1
/
experiments
/
qualifying_events
List qualifying event
curl --request GET \
  --url https://statsigapi.net/console/v1/experiments/qualifying_events \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Qualifying events listed successfully.",
  "data": [
    {
      "name": "Log Events",
      "description": "all app events including add to cart, purchase, page view, checkout",
      "tags": [],
      "sql": "SELECT *\nFROM shoppy-sales.logging.events\nwhere DATE(ts) between {statsig_start_date} and {statsig_end_date}\n",
      "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/qualifying_event/list?page=2&limit=1",
    "previousPage": null,
    "all": "/console/v1/metrics/qualifying_event/list"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

List metric source response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

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