Get Health

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/project-health
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
  • scenarioId integer(int64) Required

Query parameters

  • dataDate string

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • dataDate string(date-time) Required

      The date and time when the data was recorded

    • health integer(int32) Required

      Health score of the project

    • risk string Required

      Risk indicator of the project

      Values are GOOD, FINE, or BAD.
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/project-health 
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/scenarios/{scenarioId}/project-health' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500) 
{}
Response examples (200) 
{
  "dataDate": "2023-10-05T14:30:00+00:00",
  "health": 85,
  "risk": "Indicator.GOOD"
}