C P Q Analytics | SalesOS Docs

Get dashboard

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

startDatestring

endDatestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/dashboard?startDate=%3Cstring%3E&endDate=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get trends

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

startDatestring

endDatestring

groupBystring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/trends?startDate=%3Cstring%3E&endDate=%3Cstring%3E&groupBy=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get quote pipeline

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

curl -X GET "https://api.salesos.org/v1/analytics/cpq/quote-pipeline" \
  -H "Authorization: Bearer <token>"

Get top products

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

limitstring

sortBystring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/top-products?limit=%3Cstring%3E&sortBy=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get top accounts

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

limitstring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/top-accounts?limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get sales rep performance

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

startDatestring

endDatestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/sales-rep-performance?startDate=%3Cstring%3E&endDate=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get forecast

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

periodsstring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/forecast?periods=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get conversion funnel

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

startDatestring

endDatestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/conversion-funnel?startDate=%3Cstring%3E&endDate=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get win loss 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

startDatestring

endDatestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/win-loss?startDate=%3Cstring%3E&endDate=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get snapshots

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

startDatestring

endDatestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/snapshots?startDate=%3Cstring%3E&endDate=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Create snapshot

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

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/analytics/cpq/snapshots" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Get quotes trend

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

periodstring

rangestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/quotes/trend?period=%3Cstring%3E&range=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get orders trend

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

periodstring

rangestring

curl -X GET "https://api.salesos.org/v1/analytics/cpq/orders/trend?period=%3Cstring%3E&range=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get product performance

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

curl -X GET "https://api.salesos.org/v1/analytics/cpq/products/performance" \
  -H "Authorization: Bearer <token>"

Export data

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

curl -X GET "https://api.salesos.org/v1/analytics/cpq/export" \
  -H "Authorization: Bearer <token>"

Get quote age 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

curl -X GET "https://api.salesos.org/v1/analytics/cpq/quotes/age-analysis" \
  -H "Authorization: Bearer <token>"