Get Company Schedule Quality Metric Trend

GET /public/v1/company-trends/metric/{metricType}

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • metricType string Required

    Values are ACTIVITIES_TOTAL, ACTIVITIES_MILESTONES, ACTIVITIES_ACTIVITIES, ACTIVITY_NAME_CHANGES, RELATIONSHIPS_TOTAL, RELATIONSHIPS_START_TO_FINISH, RELATIONSHIPS_START_TO_START, RELATIONSHIPS_FINISH_TO_START, RELATIONSHIPS_FINISH_TO_FINISH, MISSING_LOGIC, LAG_NEGATIVE, LAG_POSITIVE, CONSTRAINTS_TOTAL, CONSTRAINTS_HARD, CONSTRAINTS_SOFT, LOW_FLOAT_ACTIVITIES, HIGH_FLOAT_ACTIVITIES, HIGH_DURATION_ACTIVITIES, RESOURCE_LOADED_ACTIVITIES, CRITICAL_PATH_PERCENT, AVG_ACTIVITY_TOTAL_FLOAT, SCHEDULE_COMPRESSION_INDEX, IMPORT_CHANGE_STARTED_NO_PROGRESS, IMPORT_CHANGE_FUTURE_ACTUAL_DATES, IMPORT_CHANGE_COMPLETE_BUT_NO_ACTUAL_FINISH_DATE, IMPORT_CHANGE_CHANGED_ACTUAL_DATES, IMPORT_CHANGE_DECREASED_PERCENT_COMPLETE, INVALID_FORECAST_DATE, MANUALLY_SCHEDULED_ACTIVITIES, DANGLING_ACTIVITIES, MANUALLY_SCHEDULED_SUMMARIES, DUPLICATE_RELATIONSHIPS, DUPLICATE_ACTIVITY_NAMES, IMPORT_CHANGE_LOGIC_TIE_GENERATION, IMPORT_CHANGE_SUMMARY_ASSIGNED_LOGIC, REMAINING_DURATION_DISCREPANCY, PROGRESS_OUT_OF_SEQUENCE, ACTIVITIES_RIDING_DATADATE, ACTIVITIES_SITTING_DATADATE, ONE_DAY_ACTIVITIES, BACKDATED_ACTIVITIES, ACTIVITIES_LATER_THAN_TRACKED_TO, LOE_ACTIVITIES, IMPORT_CHANGE_INCREASED_REMAINING_DURATION, NEGATIVE_NATIVE_FLOAT, CONVERGENCE_BOTTLENECKS, or DIVERGENCE_BOTTLENECKS.

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
    • metricValue number(double)
GET /public/v1/company-trends/metric/{metricType}
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/company-trends/metric/{metricType}?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",
    "metricValue": 42.0
  }
]