Get Company Schedule Compression Trend

GET /public/v1/company-trends/compression

Api key

Headers

X-COMPANY-ID string Required

The company's unique ID

Query parameters

periodType string Required

Values are BY_PERIOD or BY_MONTH.
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
- periodType string
  
  Values are BY_PERIOD or BY_MONTH.
- periodLabel string
- scheduleCompression number(double)
- scheduleCompressionIndex integer(int64)
- indicator string
  
  Values are GOOD, FINE, or BAD.

GET /public/v1/company-trends/compression

curl \
 --request GET 'https://live.smartpmtech.com/public/v1/company-trends/compression?periodType=BY_PERIOD' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"

Response examples (500)

{}

Response examples (200)

[
  {
    "companyId": "string",
    "periodType": "BY_PERIOD",
    "periodLabel": "string",
    "scheduleCompression": 42.0,
    "scheduleCompressionIndex": 42,
    "indicator": "GOOD"
  }
]