Get Company Metrics

GET /public/v1/metrics

Api key

Headers

X-COMPANY-ID string Required

The company's unique ID

Query parameters

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
- projectCount integer(int32)
- delayedProjectCount integer(int32)
- onTrackProjectCount integer(int32)
- updateNeededProjectCount integer(int32)
- averageHealth integer(int32)
- averageHealthIndicator string
  
  Values are GOOD, FINE, or BAD.
- averageQuality string
- averageQualityIndicator string
  
  Values are GOOD, FINE, or BAD.
- averageCompression number(double)
- averageCompressionIndicator string
  
  Values are GOOD, FINE, or BAD.
- averageCompressionIndex integer(int64)
- averageSPI number(double)
- averageFinishVariance integer(int64)
- averageTotalOnTimeHitRate number(double)

GET /public/v1/metrics

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

Response examples (500)

{}

Response examples (200)

{
  "projectCount": 42,
  "delayedProjectCount": 42,
  "onTrackProjectCount": 42,
  "updateNeededProjectCount": 42,
  "averageHealth": 42,
  "averageHealthIndicator": "GOOD",
  "averageQuality": "string",
  "averageQualityIndicator": "GOOD",
  "averageCompression": 42.0,
  "averageCompressionIndicator": "GOOD",
  "averageCompressionIndex": 42,
  "averageSPI": 42.0,
  "averageFinishVariance": 42,
  "averageTotalOnTimeHitRate": 42.0
}