Fale Já icon

Fale Já

Interaja com a API do Fale Já - Application, Client e Platform APIs

Actions123

Report → Get Agent Conversation Metrics

AI-generated

Summary

Get Agent Conversation Metrics

Inputs

  • apiType — Select which API to use based on your role and use case (Application API for agents/admins, Client API for end-users, Platform API for system administrators). Default: application.
  • metric (required) — The metric to get report for. Options: conversations_count, incoming_messages_count, outgoing_messages_count, avg_first_response_time, avg_resolution_time, resolutions_count. Default: conversations_count.
  • type (required) — The type of report. Options: account, agent, inbox, label, team. Default: account.
  • since — Start date for the report (Unix timestamp or date string). Default: empty.
  • until — End date for the report (Unix timestamp or date string). Default: empty.
  • id — The ID of the agent. Optional for getAgentSummary, required for getAgentConversationMetrics. Default: 0.
  • conversationId (required) — The ID of the conversation to get metrics for. Default: 0.

Output shape

Metric values for the specified report type, time range, and agent/conversation scope

Returned data shape not explicitly declared in properties or source; metric and type selections determine report content.

Examples

Example 1: Get conversations count report for all agents using Application API

apiType=application, metric=conversations_count, type=account

Links

Discussion