Support Desk analytics

Changed on

The Analytics page of the Support Desk as data. The unit of work is an inquiry: a customer message that arrives while nobody has answered yet (the first message of a conversation, or the first one after a reply). Its response time is the gap to the next reply written by a person (automatic messages do not count). Muted senders and the demo conversation are excluded.

Every KPI comes with the value of the previous period of the same length. Reports are cached for an hour; refresh=1 rebuilds. Times use the project time zone. Range for period=custom is capped at 366 days and cannot end in the future.

get/support/analytics

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/support/analytics
  • Auth
    API key in header api_key

Query parameters

period'today' | '7d' | '30d' | '90d' | 'custom'
fromstring date

Required for custom

tostring date

Required for custom, inclusive

refreshboolean

Headers

api_keystring required
X-Web2wave-Project-Idstring
Example:my-funnel

Required for client API keys (projects.project_id slug). Not needed for legacy project keys.

Response

Report

successboolean
period_presetstring
automatedinteger

Automatic messages sent in the period

closed_autointeger

Conversations closed by automation

bucket_unit'hour' | 'day'

hour for ranges up to 48 h

type_seriesobject

Stacked chart data: series, day, week, default

generated_atstring date-time

Changes