GET
/
console
/
v1
/
events
/
{eventName}
/
metrics
Get metrics using event name
curl --request GET \
  --url https://statsigapi.net/console/v1/events/{eventName}/metrics \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Metrics listed successfully.",
  "data": [
    {
      "id": "add_to_cart::event_count",
      "name": "add_to_cart",
      "directionality": "increase",
      "type": "event_count",
      "description": "",
      "isPermanent": false,
      "isReadOnly": false,
      "isHidden": false,
      "isVerified": false,
      "tags": [
        "dashboard_test"
      ],
      "createdTime": 1678165878415,
      "lineage": {
        "events": [
          "add_to_cart"
        ],
        "metrics": []
      },
      "team": null
    },
    {
      "id": "add_to_cart::event_dau",
      "name": "add_to_cart",
      "directionality": "increase",
      "type": "event_dau",
      "description": "",
      "isPermanent": false,
      "isReadOnly": false,
      "isHidden": false,
      "isVerified": false,
      "tags": [
        "asdf",
        "dashboard_test"
      ],
      "createdTime": 1680128775716,
      "lineage": {
        "events": [
          "add_to_cart"
        ],
        "metrics": []
      },
      "team": null
    },
    {
      "id": "test funnel 1::funnel",
      "name": "test funnel 1",
      "directionality": "increase",
      "type": "funnel",
      "description": "",
      "isPermanent": false,
      "isReadOnly": false,
      "isHidden": false,
      "isVerified": false,
      "tags": [],
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "createdTime": 1695253296002,
      "owner": {
        "name": "Test User"
      },
      "lineage": {
        "events": [],
        "metrics": [
          "add_to_cart::event_count",
          "add_to_cart_games::event_count_custom"
        ]
      },
      "team": null,
      "funnelCountDistinct": "events",
      "funnelEventList": [
        {
          "name": "add_to_cart",
          "type": "event_count"
        },
        {
          "name": "add_to_cart_games",
          "type": "event_count_custom"
        }
      ]
    },
    {
      "id": "super_long_metric_nameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee_thing::funnel",
      "name": "super_long_metric_nameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee_thing",
      "directionality": "increase",
      "type": "funnel",
      "description": "test",
      "isPermanent": false,
      "isReadOnly": false,
      "isHidden": false,
      "isVerified": false,
      "tags": [
        "Funnels"
      ],
      "creatorName": "Test User ",
      "creatorEmail": "test@statsig.com",
      "createdTime": 1698427486777,
      "owner": {
        "name": "Test User"
      },
      "lineage": {
        "events": [],
        "metrics": [
          "add_to_cart::event_dau",
          "new_custom_metric::event_user"
        ]
      },
      "team": null,
      "funnelCountDistinct": "users",
      "funnelEventList": [
        {
          "name": "add_to_cart",
          "type": "event_dau"
        },
        {
          "name": "new_custom_metric",
          "type": "event_user"
        }
      ]
    },
    {
      "id": "test_funnel_metric::funnel",
      "name": "test_funnel_metric",
      "directionality": "decrease",
      "type": "funnel",
      "description": "",
      "isPermanent": false,
      "isReadOnly": false,
      "isHidden": false,
      "isVerified": false,
      "tags": [
        "Funnels"
      ],
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "createdTime": 1701984009755,
      "owner": {
        "name": "Test User"
      },
      "lineage": {
        "events": [],
        "metrics": [
          "add_to_cart::event_dau"
        ]
      },
      "team": null,
      "funnelCountDistinct": "users",
      "funnelEventList": [
        {
          "name": "add_to_cart",
          "type": "event_dau"
        }
      ]
    }
  ],
  "pagination": {
    "itemsPerPage": 5,
    "pageNumber": 1,
    "totalItems": 1254,
    "nextPage": "?page=2&limit=5",
    "previousPage": null,
    "all": ""
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Path Parameters

​
eventName
string
required

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

200
application/json

Get metrics from events response

The response is of type object.