Get the AI conversation summary

GET

/api/v1/analytics/ai-conversations/summary

const url = 'https://api.inside.chat/api/v1/analytics/ai-conversations/summary?website_id=example&range=today';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.inside.chat/api/v1/analytics/ai-conversations/summary?website_id=example&range=today' \
  --header 'Authorization: Bearer <token>'

Required scopes: reports_read, conversation_read
Data access: –
MCP tool: ai_conversation_summary

Summarize AI-evidenced conversations for an explicitly granted website and a bounded historical period. Current channel, team and subsite restrictions apply. Content-derived, language and operator measures can be unavailable under the current data policy. This does not cover all conversations.

Authorizations

installation_token
oauth_client_credentials
reports_read conversation_read

Parameters

Query Parameters

website_id

required

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

An explicitly granted website.

range

string

Allowed values: today last-7-days last-month date

start

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

end

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

timezone

string

>= 1 characters <= 100 characters /^[A-Za-z0-9_+/-]+$/

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

Aggregates over AI-evidenced conversations only. Content-derived measures are null, never zero, without the required access.

object

data

required

object

meta

required

object

coverage

required

Allowed value: ai_evidenced_conversations

range

string

Allowed values: today last-7-days last-month date

start

string

end

string

time_zone

The website IANA time zone.

string

generated_at

string

source

Any of:

string

truncated

Any of:

string

cache_seconds

Any of:

string

restriction_dimensions

required

Installation restriction dimensions applied before aggregation.

Array<string>

data_access

required

object

content_derived_measures

required

boolean

language_labels

required

boolean

operator_labels

required

boolean

website

object

Any of:

string

name

Any of:

string

headline

required

object

ai_conversations

Any of:

number
null

number

ai_touched_visitors

Any of:

number
null

number

ai_assisted_conversations

Any of:

number
null

number

ai_customer_facing_conversations

Any of:

number
null

number

human_escalations

Any of:

number
null

number

summary

required

object

series

required

object

volume

required

Any of:

Array<array>
null

Conversation volume by day. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

volume_hourly

required

Any of:

Array<array>
null

Conversation volume by hour. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

platform

required

Any of:

Array<array>
null

Volume by platform. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

topics

required

Any of:

Array<array>
null

Needs content access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

language

required

Any of:

Array<array>
null

Needs PII access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

sentiment

required

Any of:

Array<array>
null

Needs content access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

resolution

required

Any of:

Array<array>
null

Needs content access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

operators

required

Any of:

Array<array>
null

Needs directory_read and PII access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

metrics

required

object

message_count

Any of:

number
null

number

visitor_message_count

Any of:

number
null

number

bot_message_count

Any of:

number
null

number

operator_message_count

Any of:

number
null

number

first_response_seconds

Any of:

number
null

number

first_response_count

Any of:

number
null

number

speed_response_seconds

Any of:

number
null

number

speed_response_count

Any of:

number
null

number

average_response_seconds

Any of:

number
null

number

duration_seconds

Any of:

number
null

number

classified_count

Any of:

number
null

number

resolved_count

Any of:

number
null

number

first_contact_count

Any of:

number
null

number

first_contact_resolved

Any of:

number
null

number

sentiment_average

Any of:

number
null

number

confidence_average

Any of:

number
null

number

confidence_count

Any of:

number
null

number

ratings

required

Any of:

Array<array>
null

Star ratings. Needs content access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

outcomes

required

Any of:

Array<array>
null

Outcomes. Needs content access. Each bucket is a [label, count] pair. null when the credential lacks the required access.

Array<array>

duration_by_platform

required

Array<object>

object

platform

required

string

conversation_count

Any of:

number
null

number

sample_count

Any of:

number
null

number

average_seconds

Any of:

number
null

number

Example

{
  "data": {
    "meta": {
      "coverage": "ai_evidenced_conversations",
      "range": "today"
    }
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.