Embedded Analytics | SalesOS Docs

List all embed tokens

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

statusstring

Value in: "ACTIVE" | "REVOKED" | "EXPIRED"

pagestring

limitstring

curl -X GET "https://api.salesos.org/v1/embedded-analytics/tokens?status=ACTIVE&page=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Create a new embed token

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/embedded-analytics/tokens" \
  -H "Authorization: Bearer <token>"

Get embed token details

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

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

Update embed token settings

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X PATCH "https://api.salesos.org/v1/embedded-analytics/tokens/<string>" \
  -H "Authorization: Bearer <token>"

Delete an embed token

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X DELETE "https://api.salesos.org/v1/embedded-analytics/tokens/<string>" \
  -H "Authorization: Bearer <token>"

Revoke an embed token

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X POST "https://api.salesos.org/v1/embedded-analytics/tokens/<string>/revoke" \
  -H "Authorization: Bearer <token>"

Preview embedded dashboard configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X GET "https://api.salesos.org/v1/embedded-analytics/tokens/<string>/preview" \
  -H "Authorization: Bearer <token>"

Get token usage analytics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X GET "https://api.salesos.org/v1/embedded-analytics/tokens/<string>/usage" \
  -H "Authorization: Bearer <token>"

Get overall embedded analytics statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

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

Regenerate embed token value

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Token ID

curl -X POST "https://api.salesos.org/v1/embedded-analytics/tokens/<string>/regenerate" \
  -H "Authorization: Bearer <token>"