A list of forecasts entries matching filter criteria
Summary:
This endpoint is used to return the json Data for the committed values of a user's forecast based on the passed in filter criteria
Query Parameters:
Param |
Description |
Optional |
user_id |
Show for a specific user, defaults to current user if not defined |
Optional |
timeperiod_id |
Show for a specific time period, defaults to the current time period if one is not passed |
Optional |
forecast_type |
Which forecast type to supply, rollup or direct |
required |
show_deleted |
control if deleted committed forecasts should be included or not |
required |
Input Example:
{
'user_id':'seed_max_id,
'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
'forecast_type':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
}
Output Example:
[ { "base_rate" : "1",
"best_case" : "649700.000000",
"currency_id" : "-99",
"date_entered" : "2013-01-17T14:39:13-05:00",
"date_modified" : "2013-01-17T14:39:13-05:00",
"deleted" : "0",
"end_date" : "2013-03-31",
"forecast_type" : "Rollup",
"id" : "cec2c6ba-5d1c-0ca8-16b7-50f8532125d8",
"likely_case" : "649800.000000",
"opp_count" : "23",
"opp_weigh_value" : "649500",
"start_date" : "2013-01-01",
"timeperiod_id" : "dcc2885a-5889-ea75-84c8-50f853d1a5ba",
"timeperiod_name" : "Q1 (01/01/2013 - 03/31/2013)",
"user_id" : "seed_jim_id",
"worst_case" : "649600.000000"
} ]