Skip to main content

Forecast API

The Forecast API exposes a small set of read/write endpoints for integrating external systems (reporting tools, drilling dashboards, daily-update workflows) with Oliasoft Forecast estimates and the project time tracker.

The endpoints documented here live under /api/integrations/external/ on the Forecast service and are authenticated with the same apikey header used elsewhere in the Oliasoft API.

Base URL

All endpoints are at the following BASE URL:

https://forecast.api.oliasoft.com

Available Endpoints

Estimates

EndpointMethodDescription
List EstimatesGET /api/integrations/external/estimates/List all estimates the authenticated user can access, enriched with well hierarchy

Time Tracker

EndpointMethodDescription
Get Time TrackerGET /api/integrations/external/estimates/time-tracker/{projectId}Sections → operations → activities for a project, plus AFE / P10 / P90 / variance totals
Update Time Tracker TaskPATCH /api/integrations/external/estimates/time-tracker/{projectId}/task/{taskId}Update a single operation (name only) or activity (name, estimate, actual, actualDepth); resyncs the parent operation when activity hours change

Typical integration flow

  1. Call List Estimates to discover the projectId (and companyId) for the wells you care about.
  2. Call Get Time Tracker with that projectId and companyId to pull the latest snapshot — sections, operations, activities, and the project's overall AFE / P10 / P90 / variance from the last active simulation.
  3. As actuals come in from the field, call Update Time Tracker Task to record actual hours and actualDepth against individual activities. The parent operation's start / finish times are resynced automatically.

Authentication

All endpoints require the apikey header:

apikey: YOUR_API_KEY

Keys are scoped to a customer — calls to List Estimates only return estimates for companies the API key's user belongs to, and Get Time Tracker / Update Time Tracker Task can only operate on projects within those companies.

API Information

Base URLs

Production Environment
forecast.oliasoft.com
QA/Testing Environment
forecast.qa.oliasoft.com

API Details

Auth:API Key
Rate Limit:500 req/min