Get ROI insights

GET

/api/v1/insights/roi

The two halves of the ROI calculation: what the platform did (UnlessUsageStatistics, broken down by AI assistant, team assistant and API) and the business figures it is measured against (WebsiteBusinessStatistics).

Notes

• Needs no date range; it reports over the account’s full history
• WebsiteBusinessStatistics is null until the figures have been entered, which is dashboard-only. Without them there is nothing to measure the usage against

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.

Responses

200

Usage and business statistics for the workspace.

object

status

string

lastUpdate

number

UnlessUsageStatistics

What the platform handled, split by the surface it came through.

object

aiAssistantInsights

object

sessions

number

conversations

number

questions

number

answeredQuestions

number

escalations

number

teamAssistantInsights

object

sessions

number

conversations

number

questions

number

answeredQuestions

number

summarizations

number

apiInsights

object

sessions

number

conversations

number

questions

number

answeredQuestions

number

summarizations

number

accountWideInsights

object

totalConversations

number

WebsiteBusinessStatistics

object

accountId

string

websiteId

string

averageMonthlyTicketsWithoutAI

number

averageHumanHandlingTimePerTicketMinutes

number

averageHumanHandlingTimePerTicketWithAIMinutes

number

averageHourlyRateForTeamMember

number

expectedAnnualCompanyGrowthRate

number

countApiAsTeamEfficiency

boolean

weeklyDashboardHours

number

createdAt

number

updatedAt

number

401

Unauthorized - invalid API key.