Metrics LIST

GET 
/metrics

Required Permissions: Metric List or Metric Admin

Request

Query Parameters

sort string

The object key to sort the results by.

sort_asc boolean
page integer
items integer
owners string
Possible values: Value must match regular expression ^,+
A list of owner_ids for filtering, separated by commas.
Example: 1,2,3
teams string
Possible values: Value must match regular expression ^,+
A list of team_ids for filtering, separated by commas.
Example: 1,2,3

Responses

200

A JSON Object containing an array of all metrics.

application/json

Schema

Schema

items integer
page integer

Possible values: >= 1

total integer
metrics object[]
Array [
id integer
goal_id integer
name string
description string
type string
effect string
Possible values: [positive, negative, unknown]
archived boolean
format_str string
scale integer
precision number
value_source_property string
property_filter string
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
goal object
id integer
name string
description string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
archived boolean
tags object[]
Array [
goal_id integer
goal
goal_tag_id integer
goal_tag object
id integer
tag string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
goals undefined[]
]
teams object[]
Array [
goal_id integer
goal
team_id integer
team object
id integer
external_id integernullable
name string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
users object[]
Array [
user_id integer
user object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
team_id integer
team
]
experiments ExperimentTeam[]
goals undefined[]
metrics object[]
Array [
metric_id integer
metric
team_id integer
team
]
]
owners object[]
Array [
goal
goal_id integer
user object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
user_id integer
]
metrics undefined[]
tags object[]
Array [
id integer
tag string
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
]
owners object[]
Array [
metric_id integer
user_id integer
user object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
]
teams object[]
Array [
metric_id integer
metric
team_id integer
team object
id integer
external_id integernullable
name string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
users object[]
Array [
user_id integer
user object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
team_id integer
team
]
experiments ExperimentTeam[]
goals object[]
Array [
goal_id integer
goal object
id integer
name string
description string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
archived boolean
tags object[]
Array [
goal_id integer
goal
goal_tag_id integer
goal_tag object
id integer
tag string
created_at date-time
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
created_by_user_id integer
updated_at date-timenullable
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by_user_id integernullable
goals undefined[]
]
teams undefined[]
owners object[]
Array [
goal
goal_id integer
user object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
user_id integer
]
metrics undefined[]
team_id integer
team
]
metrics undefined[]
]
]

Example (from schema)

{
  "items": 1,
  "page": 0,
  "total": 1,
  "metrics": [
    {
      "id": 0,
      "goal_id": 70,
      "name": "Time to Book",
      "description": "The amount of time before a booking has been made",
      "type": "goal_time_to_achievement",
      "effect": "positive",
      "archived": false,
      "format_str": "{}s",
      "scale": 1,
      "precision": 0,
      "value_source_property": "",
      "property_filter": "",
      "created_at": "2024-12-02T14:38:57.849Z",
      "created_by_user_id": 1,
      "updated_at": "2024-12-02T14:38:57.849Z",
      "updated_by_user_id": 0,
      "goal": {
        "id": 0,
        "name": "purchase",
        "description": "A goal for tracking how many purchases are made on any of our applications",
        "created_at": "2024-12-02T14:38:57.849Z",
        "created_by": {
          "archived": false,
          "avatar": {},
          "avatar_file_upload_url": "/cropUrl/100x100/1.png",
          "created_at": "2024-12-02T14:38:57.849Z",
          "created_by_user_id": 0,
          "department": "Marketing",
          "email": "user@example.com"
        },
        "created_by_user_id": 0,
        "updated_at": "2024-12-02T14:38:57.849Z",
        "updated_by": {
          "archived": false,
          "avatar": {},
          "avatar_file_upload_url": "/cropUrl/100x100/1.png",
          "created_at": "2024-12-02T14:38:57.849Z",
          "created_by_user_id": 0,
          "department": "Marketing",
          "email": "user@example.com"
        },
        "updated_by_user_id": 0,
        "archived": false,
        "tags": [
          {
            "goal_id": 0,
            "goal_tag_id": 0,
            "goal_tag": {
              "id": 0,
              "tag": "psychological:Trust",
              "created_at": "2024-12-02T14:38:57.849Z",
              "created_by": {
                "archived": false,
                "avatar": {},
                "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                "created_at": "2024-12-02T14:38:57.849Z",
                "created_by_user_id": 0,
                "department": "Marketing",
                "email": "user@example.com"
              },
              "created_by_user_id": 0,
              "updated_at": "2024-12-02T14:38:57.849Z",
              "updated_by": {
                "archived": false,
                "avatar": {},
                "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                "created_at": "2024-12-02T14:38:57.849Z",
                "created_by_user_id": 0,
                "department": "Marketing",
                "email": "user@example.com"
              },
              "updated_by_user_id": 0,
              "goals": [
                null
              ]
            }
          }
        ],
        "teams": [
          {
            "goal_id": 0,
            "team_id": 0,
            "team": {
              "id": 0,
              "external_id": 0,
              "name": "Marketing",
              "created_at": "2024-12-02T14:38:57.850Z",
              "created_by": {
                "archived": false,
                "avatar": {},
                "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                "created_at": "2024-12-02T14:38:57.850Z",
                "created_by_user_id": 0,
                "department": "Marketing",
                "email": "user@example.com"
              },
              "created_by_user_id": 0,
              "updated_at": "2024-12-02T14:38:57.850Z",
              "updated_by": {
                "archived": false,
                "avatar": {},
                "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                "created_at": "2024-12-02T14:38:57.850Z",
                "created_by_user_id": 0,
                "department": "Marketing",
                "email": "user@example.com"
              },
              "updated_by_user_id": 0,
              "users": [
                {
                  "user_id": 0,
                  "user": {
                    "archived": false,
                    "avatar": {},
                    "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                    "created_at": "2024-12-02T14:38:57.850Z",
                    "created_by_user_id": 0,
                    "department": "Marketing",
                    "email": "user@example.com"
                  },
                  "team_id": 0
                }
              ],
              "experiments": [
                null
              ],
              "goals": [
                null
              ],
              "metrics": [
                {
                  "metric_id": 0,
                  "team_id": 0
                }
              ]
            }
          }
        ],
        "owners": [
          {
            "goal_id": 0,
            "user": {
              "archived": false,
              "avatar": {},
              "avatar_file_upload_url": "/cropUrl/100x100/1.png",
              "created_at": "2024-12-02T14:38:57.850Z",
              "created_by_user_id": 0,
              "department": "Marketing",
              "email": "user@example.com"
            },
            "user_id": 0
          }
        ],
        "metrics": [
          null
        ]
      },
      "tags": [
        {
          "id": 0,
          "tag": "location:Header",
          "created_at": "2024-12-02T14:38:57.850Z",
          "created_by_user_id": 0,
          "updated_at": "2024-12-02T14:38:57.850Z",
          "updated_by_user_id": 0
        }
      ],
      "owners": [
        {
          "metric_id": 0,
          "user_id": 0,
          "user": {
            "archived": false,
            "avatar": {},
            "avatar_file_upload_url": "/cropUrl/100x100/1.png",
            "created_at": "2024-12-02T14:38:57.850Z",
            "created_by_user_id": 0,
            "department": "Marketing",
            "email": "user@example.com"
          }
        }
      ],
      "teams": [
        {
          "metric_id": 0,
          "team_id": 0,
          "team": {
            "id": 0,
            "external_id": 0,
            "name": "Marketing",
            "created_at": "2024-12-02T14:38:57.851Z",
            "created_by": {
              "archived": false,
              "avatar": {},
              "avatar_file_upload_url": "/cropUrl/100x100/1.png",
              "created_at": "2024-12-02T14:38:57.851Z",
              "created_by_user_id": 0,
              "department": "Marketing",
              "email": "user@example.com"
            },
            "created_by_user_id": 0,
            "updated_at": "2024-12-02T14:38:57.851Z",
            "updated_by": {
              "archived": false,
              "avatar": {},
              "avatar_file_upload_url": "/cropUrl/100x100/1.png",
              "created_at": "2024-12-02T14:38:57.851Z",
              "created_by_user_id": 0,
              "department": "Marketing",
              "email": "user@example.com"
            },
            "updated_by_user_id": 0,
            "users": [
              {
                "user_id": 0,
                "user": {
                  "archived": false,
                  "avatar": {},
                  "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                  "created_at": "2024-12-02T14:38:57.851Z",
                  "created_by_user_id": 0,
                  "department": "Marketing",
                  "email": "user@example.com"
                },
                "team_id": 0
              }
            ],
            "experiments": [
              null
            ],
            "goals": [
              {
                "goal_id": 0,
                "goal": {
                  "id": 0,
                  "name": "purchase",
                  "description": "A goal for tracking how many purchases are made on any of our applications",
                  "created_at": "2024-12-02T14:38:57.852Z",
                  "created_by": {
                    "archived": false,
                    "avatar": {},
                    "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                    "created_at": "2024-12-02T14:38:57.852Z",
                    "created_by_user_id": 0,
                    "department": "Marketing",
                    "email": "user@example.com"
                  },
                  "created_by_user_id": 0,
                  "updated_at": "2024-12-02T14:38:57.852Z",
                  "updated_by": {
                    "archived": false,
                    "avatar": {},
                    "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                    "created_at": "2024-12-02T14:38:57.852Z",
                    "created_by_user_id": 0,
                    "department": "Marketing",
                    "email": "user@example.com"
                  },
                  "updated_by_user_id": 0,
                  "archived": false,
                  "tags": [
                    {
                      "goal_id": 0,
                      "goal_tag_id": 0,
                      "goal_tag": {
                        "id": 0,
                        "tag": "psychological:Trust",
                        "created_at": "2024-12-02T14:38:57.852Z",
                        "created_by": {
                          "archived": false,
                          "avatar": {},
                          "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                          "created_at": "2024-12-02T14:38:57.852Z",
                          "created_by_user_id": 0,
                          "department": "Marketing",
                          "email": "user@example.com"
                        },
                        "created_by_user_id": 0,
                        "updated_at": "2024-12-02T14:38:57.852Z",
                        "updated_by": {
                          "archived": false,
                          "avatar": {},
                          "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                          "created_at": "2024-12-02T14:38:57.852Z",
                          "created_by_user_id": 0,
                          "department": "Marketing",
                          "email": "user@example.com"
                        },
                        "updated_by_user_id": 0,
                        "goals": [
                          null
                        ]
                      }
                    }
                  ],
                  "teams": [
                    null
                  ],
                  "owners": [
                    {
                      "goal_id": 0,
                      "user": {
                        "archived": false,
                        "avatar": {},
                        "avatar_file_upload_url": "/cropUrl/100x100/1.png",
                        "created_at": "2024-12-02T14:38:57.852Z",
                        "created_by_user_id": 0,
                        "department": "Marketing",
                        "email": "user@example.com"
                      },
                      "user_id": 0
                    }
                  ],
                  "metrics": [
                    null
                  ]
                },
                "team_id": 0
              }
            ],
            "metrics": [
              null
            ]
          }
        }
      ]
    }
  ]
}

Loading...