Skip to main content

Metrics LIST‚Äč

Required Permissions: Metric List or Metric Admin

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

A JSON Object containing an array of all metrics.


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-time nullable
    updated_by_user_id integer nullable
    goal object
    id integer
    name string
    description string
    created_at date-time
    created_by object
    archived boolean
    avatar object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    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 object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    goals undefined[]
  • ]
  • teams object[]
  • Array [
  • goal_id integer
    goal
    team_id integer
    team object
    id integer
    external_id integer nullable
    name string
    created_at date-time
    created_by object
    archived boolean
    avatar object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    users object[]
  • Array [
  • user_id integer
    user object
    archived boolean
    avatar object nullable
    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 object nullable
    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-time nullable
    updated_by_user_id integer nullable
  • ]
  • owners object[]
  • Array [
  • metric_id integer
    user_id integer
    user object
    archived boolean
    avatar object nullable
    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 integer nullable
    name string
    created_at date-time
    created_by object
    archived boolean
    avatar object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    users object[]
  • Array [
  • user_id integer
    user object
    archived boolean
    avatar object nullable
    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 object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    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 object nullable
    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-time nullable
    updated_by object nullable
    archived boolean
    avatar object nullable
    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 integer nullable
    goals undefined[]
  • ]
  • teams undefined[]
    owners object[]
  • Array [
  • goal
    goal_id integer
    user object
    archived boolean
    avatar object nullable
    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[]
  • ]
  • ]
Loading...