Class CXoneRealtimeReportService

Class to handle Agent and Team Performance Report API calls

Hierarchy

CXoneRealtimeReportService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CXoneRealtimeReportService(): CXoneRealtimeReportService

example
Returns CXoneRealtimeReportService

Properties

GET_AGENT_PERFORMANCE_REPORT

GET_AGENT_PERFORMANCE_REPORT: string = '/incontactapi/services/v23.0/agents/{agentId}/performance'

GET_AGENT_STATE_PERFORMANCE_REPORT

GET_AGENT_STATE_PERFORMANCE_REPORT: string = '/incontactapi/services/v27.0/agents/{agentId}/state-history'

GET_TEAM_PERFORMANCE_TOTAL_REPORT

GET_TEAM_PERFORMANCE_TOTAL_REPORT: string = '/incontactapi/services/v27.0/teams/{teamId}/performance-total'

Private auth

auth: CXoneAuth

logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

getAgentPerformance

getAgentPerformance(agentId: string, startDate: string, endDate: string): Promise<AgentPerformanceResponse>

Method to fetch agent performance report using agentId
example
- getAgentPerformance
Parameters
- agentId: string
- startDate: string
  
  ISO 8601 beginning of report interval (from)
- endDate: string
  
  ISO 8601 end of report interval (to)
Returns Promise<AgentPerformanceResponse>
- API Returns Response JSON with Agent Performance Details

getAgentStateHistory

getAgentStateHistory(agentId: string, startDate: string, endDate: string): Promise<AgentStateHistoryResponse>

Method to fetch agent's state performance report using agentId
example
- getAgentStateHistory
Parameters
- agentId: string
- startDate: string
  
  ISO 8601 beginning of report interval (from)
- endDate: string
  
  ISO 8601 end of report interval (to)
Returns Promise<AgentStateHistoryResponse>
- API Returns Response JSON with agent's state Performance Details within a specific duration

getTeamPerformance

getTeamPerformance(teamId: string, startDate: string, endDate: string): Promise<TeamPerformanceResponse>

Method to fetch team performance report using teamId
example
- getTeamPerformance
Parameters
- teamId: string
- startDate: string
  
  ISO 8601 beginning of report interval (from)
- endDate: string
  
  ISO 8601 end of report interval (to)
Returns Promise<TeamPerformanceResponse>
- API Returns Response JSON with team Performance Details within a specific duration

Generated using TypeDoc