Get conversation details

GET

/api/v1/ai/conversations/details

The stored analysis of one conversation: its metadata, sentiment, rating, outcome and tags.

Notes

• conversations__conversationId is required
• A conversation belonging to another account or workspace answers 404, not 403
• Use GET /api/v1/visitors/conversations with a conversationId when you want the messages rather than the analysis

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

conversations__conversationId

required

string

The conversation’s id.

conversationUrl

string

Responses

200

The conversation’s details.

400

Bad request - missing websiteId or conversation id.

401

Unauthorized - invalid API key.

404

The conversation does not belong to this account and workspace.