Overview

Forecast Named Metrics

Summary

Returns named metrics data for Forecasts-related modules

Request Example

{InstanceURL}/rest/v11_20/Forecasts/metrics/named

Request Arguments

Metric(s) name Time period Type User ID
array string string string

Response Arguments

Metric(s) name Type Value
string string string

Request Example

{
    "user_id": "67aa9afe-ba92-11ec-b8e3-acde48001122",
    "type": "Direct",
    "time_period": "4c420ef0-d9c7-11ed-bfa7-0242ac150006",
    "metrics": [
        "pct_won_commitment",
        "forecast_gap_coverage"
    ]
}

Response Example

{
    "pct_won_quota":
        {
            "type": "ratio",
            "value": 0
        },
    "forecast_gap_coverage":
        {
            "type": "ratio",
            "value": 0
        }
}

Change Log

Version Change
v13_1 Added /Forecasts/metrics/named POST endpoint.