Skip to main content
GET
/
v1
/
crm
/
dashboard
/
agent
/
kpi-metrics
Agent KPI Metrics
curl --request GET \
  --url https://api.example.com/v1/crm/dashboard/agent/kpi-metrics \
  --header 'Authorization: Bearer <token>'
{
  "processingVolYtd": 123,
  "processingVolMtd": 123,
  "activeMerchants": 123
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Query Parameters

​
startDate
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
​
endDate
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
​
clientIds

Response

KPI metrics for the agent dashboard.

​
processingVolYtd
number
required
​
processingVolMtd
number
required
​
activeMerchants
number
required