Get metadata summary by type

GET /public/v1/project-metadata/summary

Api key

Headers

X-COMPANY-ID string Required

Query parameters

type string

Values are LOWEST_HEALTH, LOWEST_QUALITY, or MOST_COMPRESSED.
count integer(int32)
filters array[string]
qualityProfileId integer(int64)
projectMetricFilter string

Values are PROJECTS_DELAYED, PROJECTS_ON_TRACK, PROJECTS_NEEDING_UPDATES, or PROJECTS_LOW_QUALITY.

Responses

500 */*

Internal Server Error
200 */*

OK
Hide response attributes Show response attributes object
- companyId string
- name string
- count integer(int32)
- health integer(int32)
- healthIndicator string
  
  Values are GOOD, FINE, or BAD.
- grade object
  
  Hide grade attributes Show grade attributes object
  
  mark string
  
  indicator string
  
  Values are GOOD, FINE, or BAD.
  
  score number(double)
- compression number(double)
- compressionIndex integer(int64)
- compressionIndicator string
  
  Values are GOOD, FINE, or BAD.

GET /public/v1/project-metadata/summary

curl \
 --request GET 'https://live.smartpmtech.com/public/v1/project-metadata/summary' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"

Response examples (500)

{}

Response examples (200)

[
  {
    "companyId": "string",
    "name": "string",
    "count": 42,
    "health": 42,
    "healthIndicator": "GOOD",
    "grade": {
      "mark": "string",
      "indicator": "GOOD",
      "score": 42.0
    },
    "compression": 42.0,
    "compressionIndex": 42,
    "compressionIndicator": "GOOD"
  }
]