Get Hit Rate

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish-hit-rate
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

  • filterId array[integer(int64)]
  • activityCodeFilter array[integer(int64)]
  • dataDate string

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attribute Show response attribute object
    • hitRates array[object]
      Hide hitRates attributes Show hitRates attributes object
      • dataDate string(date-time)
      • total integer(int64)
      • startedLate integer(int64)
      • finishedLate integer(int64)
      • didNotStart integer(int64)
      • didNotFinish integer(int64)
      • startedOnTime integer(int64)
      • finishedOnTime integer(int64)
      • startedOnTimeHitRate number(double)
      • finishedOnTimeHitRate number(double)
      • totalOnTimeHitRate number(double)
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish-hit-rate 
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish-hit-rate' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500) 
{}
Response examples (200) 
{
  "hitRates": [
    {
      "dataDate": "2025-05-04T09:42:00Z",
      "total": 42,
      "startedLate": 42,
      "finishedLate": 42,
      "didNotStart": 42,
      "didNotFinish": 42,
      "startedOnTime": 42,
      "finishedOnTime": 42,
      "startedOnTimeHitRate": 42.0,
      "finishedOnTimeHitRate": 42.0,
      "totalOnTimeHitRate": 42.0
    }
  ]
}