Usage of "filter by well" in a lot of the API endpoints

Forum
1

Hi CC Team,

I see the well parameter in a lot of the API endpoints which is explained to be “filter by well”. One of the endpoints is " get-forecast-output-by-id". Could you please point me to the documentation of this option? Could a list of well APIs be used here to constrain the returned values?

Thanks.

2

The “get-forecast-output-by-id” endpoint will return a single Forecast Output record by the Forecast Output Id value. The response from this endpoint would look like the below contract (which can be found in our API documentation linked above):

image
image846×584 22.6 KB

If you would like to retrieve all Forecast Output records for a single well you would want to use the “get-forecast-outputs” method and pass in the “well” querystring parameter. The resulting path would look something like this: v1/projects/:projectId/forecasts/:forecastId/outputs?well=:wellId

This endpoint currently only supports filtering by one Well at a time, so if you need to query Forecast Outputs for multiple specific Wells you will need to issue a separate request for each well. If you do not provide a “well” querystring parameter then the endpoint will just return Forecast Outputs for all Wells.

1 Like
3

Thanks Jeff for the answer. I have one follow-up question since we on the forecast output topic. Instead of getting the forecast parameters using the GetForecastOutputs endpoint for say the Arps calculation, I could also use the GetForecastDailyVolumes endpoint to get the actual daily volumes to save me from performing the Arps calculation. Please confirm.

4

That is correct. The ‘get-forecast-daily-volumes’ and ‘get-forecast-monthly-volumes’ endpoints implement the logic found in this forum post as a convenience to transform the Forecast Outputs to Forecast Volumes. This can be a large amount of data though, so your individual use case will determine which option works better for you.

It should be noted that the ‘get-forecast-daily-volumes’ currently exports only the first five years of the Forecast Volumes. We have items on our backlog to add a date filter to this endpoint to allow pulling different/larger sections of the volumes. The ‘get-forecast-monthly-volumes’ endpoint does not have this restriction.

1 Like