# dashboard#metrics

Get metrics about policies, policy sets and evaluations

Endpoint: GET /pm/api/v1/dashboard
Version: 1.0
Security: 

## Query parameters:

  - `range` (string)
    The time period over which to aggregate dashboard data. Can be: 24 hours, 7 days or 30 days
    Enum: "24h", "7d", "30d"

  - `accountIdentifier` (string)
    Harness account ID
    Example: "eBqAoNchMLKigC_qZ5EdC"

  - `orgIdentifier` (string)
    Harness organization ID
    Example: "test-org"

  - `projectIdentifier` (string)
    Harness project ID
    Example: "test-project"

## Header parameters:

  - `x-api-key` (string)
    Harness PAT key used to perform authorization
    Example: "Voluptas quis est ut numquam consequatur."

## Response 200 fields (application/json):

  - `aggregates` (array, required)
    Aggregate evaluation counts by day
    Example: [{"error":6675090623294860000,"pass":4584903984207240700,"time":5601335008037813000,"warning":6844872243202899000},{"error":6675090623294860000,"pass":4584903984207240700,"time":5601335008037813000,"warning":6844872243202899000},{"error":6675090623294860000,"pass":4584903984207240700,"time":5601335008037813000,"warning":6844872243202899000}]

  - `aggregates.error` (integer, required)
    Count of evaluations that have a status of 'error'
    Example: 461336571987123800

  - `aggregates.pass` (integer, required)
    Count of evaluations that have a status of 'pass'
    Example: 1420350174013308700

  - `aggregates.time` (integer, required)
    The Unix time of this particular aggregation
    Example: 7690880573010495000

  - `aggregates.warning` (integer, required)
    Count of evaluations that have a status of 'warning'
    Example: 1069062070157686400

  - `policy_health` (object, required)
    Policy health metrics
    Example: {"total_evaluation_count":912181450088740900,"total_evaluation_entity_count":{"error":5089901746955059000,"pass":8819252736165018000,"warning":6206446740737916000},"total_policy_count":3481527013630481400,"total_policy_set_count":7301593525736415000,"total_policy_set_entity_count":{"Ea vel odio quo.":5342886144574306000,"Nihil pariatur.":5303474591449513000}}

  - `policy_health.total_evaluation_count` (integer, required)
    Total number of evaluations that have occurred
    Example: 912181450088740900

  - `policy_health.total_evaluation_entity_count` (object, required)
    Evaluation counts by status
    Example: {"error":340096524788087740,"pass":2655229219909846500,"warning":8925618092889901000}

  - `policy_health.total_policy_count` (integer, required)
    Total number of policies stored
    Example: 3481527013630481400

  - `policy_health.total_policy_set_count` (integer, required)
    Total number of policy sets stored
    Example: 7301593525736415000

  - `policy_health.total_policy_set_entity_count` (object, required)
    Total number of policy sets by type
    Example: {"Ea vel odio quo.":5342886144574306000,"Nihil pariatur.":5303474591449513000}

## Response 400 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true

## Response 401 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true

## Response 403 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true

## Response 404 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true

## Response 500 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true

## Response 502 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true