Analytics and logs

Get metrics

Get the metrics for the specified organization.

get/orgs/analytics/metrics

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/analytics/metrics
  • Auth: HTTP bearer

Query parameters

metric'chats_created' | 'chats_user_messages_sent' | 'chats_ai_messages_sent' | 'chats_assistant_created' | 'chats_assistant_user_messages_sent' | 'chats_assistant_ai_messages_sent' | 'assistant_messages_sent' | 'assistant_chats_closed_by_human' | 'assistant_chats_closed_by_ai' | 'assistant_chats_transferred_to_human' | 'assistant_chats_reopened' | 'assistant_chats_human_replied' | 'assistant_chats_takeover_no_reply' | 'chats_assistant_member_messages_sent' | 'chats_channel_messages' | 'agent_runs_started' | 'routine_runs_started' | 'contacts_blocked_by_ai' | 'contacts_blocked_by_human' | 'chats_created_by_channel' | 'broadcasts_sent' | 'broadcasts_messages_sent' | 'broadcasts_marketing_messages_sent' | 'broadcasts_transactional_messages_sent' | 'broadcasts_messages_by_channel' | 'assistant_csat_score_1' | 'assistant_csat_score_2' | 'assistant_csat_score_3' | 'assistant_csat_score_4' | 'assistant_csat_score_5' | 'workflows_created' | 'runs_created' | 'runs_succeeded' | 'runs_failed' | 'contacts_created' | 'contacts_unsubscribed' | 'contacts_blocked' required
interval'hour' | 'day' | 'week' | 'month' | 'year'
from_datestring date-time nullable
to_datestring date-time nullable
timezonestring

IANA timezone identifier (e.g. America/New_York)

assistant_idstring
workflow_idstring
agent_idstring
routine_idstring
pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

The metrics for the specified organization.

datestring date-time nullable required
amountnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.