SalesOS

Dashboard

Dashboard data and widgets

Get hot leads based on mode

GET
/v1/dashboard/hot-leads

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

modestring
limitstring
curl -X GET "https://api.salesos.org/v1/dashboard/hot-leads?mode=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Get upcoming meetings/demos based on mode

GET
/v1/dashboard/upcoming-meetings

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

modestring
limitstring
curl -X GET "https://api.salesos.org/v1/dashboard/upcoming-meetings?mode=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Get dashboard stats based on mode Returns real-time metrics calculated from actual data

GET
/v1/dashboard/stats

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

modestring
curl -X GET "https://api.salesos.org/v1/dashboard/stats?mode=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Get comprehensive rep dashboard data in one call Works with local, salesforce, and oracle_cx modes

GET
/v1/dashboard/rep-metrics

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

modestring
curl -X GET "https://api.salesos.org/v1/dashboard/rep-metrics?mode=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Reports

Reporting and analytics

Custom Dashboards

User-created custom dashboards