Embedded URLs

Generate an embedded URL

View as Markdown

Create a URL for an existing Conversation or Customer dashboard view. The selected dashboard user must already have access. The URL expires after 60 minutes; treat it as opaque. This returns a dashboard URL, not analytics JSON. Embedding guide.

Authentication

AuthorizationBearer
Existing private account API key from Developer Hub. Keep it on your backend.

Request

This endpoint expects an object.
service_idstringRequired

Authorized project/service name.

request_idstringRequired

Existing conversation ID or customer ID, matching request_type.

request_typeenumRequired
Dashboard view to embed.
emailstringRequiredformat: "email"
Dashboard user who already has access to the project.

Response

Request acknowledgement or initiation result; see the response fields.

embedded_urlstringformat: "uri"
Opaque URL for the requested dashboard view. Expires 60 minutes after creation. Use it unchanged and do not publicly share it.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error