SalesOS

Forecast Intelligence

AI-powered revenue forecasting

Get full forecast intelligence dashboard data

GET
/v1/forecast-intelligence

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber

Fiscal quarter (1-4)

yearnumber

Fiscal year

curl -X GET "https://api.salesos.org/v1/forecast-intelligence?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

{}

Explain the forecast figures from data

GET
/v1/forecast-intelligence/explain

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber
yearnumber
curl -X GET "https://api.salesos.org/v1/forecast-intelligence/explain?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

{}

AI narrative for the forecast explanation

POST
/v1/forecast-intelligence/explain/narrative

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber
yearnumber

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/forecast-intelligence/explain/narrative?quarter=0&year=0" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Generate predictive forecast with confidence intervals

GET
/v1/forecast-intelligence/predict

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber

Fiscal quarter (1-4)

yearnumber

Fiscal year

curl -X GET "https://api.salesos.org/v1/forecast-intelligence/predict?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

{}

Forecast accuracy over time — predicted vs actual

GET
/v1/forecast-intelligence/accuracy

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

lookbackQuartersnumber

Number of past quarters to analyze (default 6)

curl -X GET "https://api.salesos.org/v1/forecast-intelligence/accuracy?lookbackQuarters=0" \
  -H "Authorization: Bearer <token>"

Forecast waterfall — week-over-week changes

GET
/v1/forecast-intelligence/waterfall

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber

Fiscal quarter (1-4)

yearnumber

Fiscal year

curl -X GET "https://api.salesos.org/v1/forecast-intelligence/waterfall?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

[
  {}
]

Gap analysis — quota vs forecast gap per rep

GET
/v1/forecast-intelligence/gap-analysis

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber

Fiscal quarter (1-4)

yearnumber

Fiscal year

curl -X GET "https://api.salesos.org/v1/forecast-intelligence/gap-analysis?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

Deal risk flags — identify at-risk deals

GET
/v1/forecast-intelligence/deal-risks

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

quarternumber

Fiscal quarter (1-4)

yearnumber

Fiscal year

curl -X GET "https://api.salesos.org/v1/forecast-intelligence/deal-risks?quarter=0&year=0" \
  -H "Authorization: Bearer <token>"

[
  {}
]

Embedded Analytics

Embeddable analytics widgets

Revenue Intelligence

Revenue analytics and channel attribution