User-based statistics
Retrieve User Based Statistics, filtered according to given options.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/statistics/userbased |
| Options | from, to, dimensions, projects, users, of |
| Body | N/A |
| Response | |
| Body | Requested user-based statistic records in tabulator-tabbed, CSV or JSON format. |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your call centre’s unique identifier (subdomain). |
Options
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| dimensions | string | yes | Dimensions. If there are several items, they should be separated with commas (e.g: dimensions=project, user,time). Possible values: – project – user – date – time |
| from | string | yes | First date of the requested time period to be searched, in yyyymmdd format (e.g: from=20210301). |
| of | string | no | Output format. Possible values: – tab – cvs – json (default) |
| projects | integer | no | Optional field. Defaults to active projects. From which specific project(s) should data be retrieved. If there are several items, they should be separated with commas. (e.g: projects=53,64). |
| to | string | yes | Last date of the requested time period to be searched, in yyyymmdd format (e.g: from=20120331). |
| users | integer | no | Optional field. Defaults to all agents with system users. Defines from which specific user(s) should data be retrieved. If there are several items, they should be separated with commas. (e.g: users=53,64). |
| hide_system_users | boolean | no | Possible values: true, false, default: false. Defines whether statistics of system users are returned. |
| fields | string | no | List of specific KPIs to request (e.g: ticketCreated,emailByAgentSent). If not populated, all KPIs are returned. |
| preset | integer | no | Column preset ID. Returns the KPIs that belong to a defined column preset set up in VCC Live. Only returns data if fields is not specified. |
Tip: You can download via API the meaning and list of all statistic KPIs, read more about it here
Response
Response object
| Name | Type | Comment |
|---|---|---|
| date | string | Date in yyyy-mm-dd format. |
| time | integer | Time in hhmm format. |
| projectId | integer | Project identifier. |
| userId | integer | User identifier. |
| data | array | field: The name of the field the values belong to. count: Number of values belonging to the specified field for the specified date. sum: The value itself. |
Example
List user-based statistics of projectid:2 between 06.01.2020. and 06.31.2020. based on the ‘project,user,date,time’ dimensions.
https://mycc.asp.virtual-call-center.eu/v2/statistics/userbased?from=202000106&to=20200106&dimensions=project,user,date,time&projects=2&users=17
Response body
{
"response": [
{
"date": "2020-06-15",
"time": 1500,
"projectId": 2,
"userId": 17,
"data": [
{
"field": "userstateAvailable",
"count": 1,
"sum": 160
},
{
"field": "dispositionStatusRecall",
"count": 1,
"sum": null
},
{
"field": "dispositionReachFailed",
"count": 1,
"sum": null
},
{
"field": "userstateAfterwork",
"count": 1,
"sum": 5
},
{
"field": "userstateCall",
"count": null,
"sum": 7
},
{
"field": "callOut",
"count": null,
"sum": 7
}
],
"level": 3
},
{
"date": "2020-06-23",
"time": 1400,
"projectId": 2,
"userId": 17,
"data": [
{
"field": "userstateAvailable",
"count": 1,
"sum": 180
},
{
"field": "dispositionStatusRecall",
"count": 2,
"sum": null
},
{
"field": "dispositionReachFailed",
"count": 1,
"sum": null
},
{
"field": "userstateAfterwork",
"count": 1,
"sum": 10
},
{
"field": "userstateCall",
"count": null,
"sum": 81
},
{
"field": "callOut",
"count": null,
"sum": 82
}
],
"level": 3
},
{
"date": "2020-06-23",
"time": 1500,
"projectId": 2,
"userId": 17,
"data": [
{
"field": "userstateAvailable",
"count": 1,
"sum": 220
},
{
"field": "dispositionStatusRecall",
"count": 1,
"sum": null
},
{
"field": "dispositionReachFailed",
"count": 3,
"sum": null
},
{
"field": "userstateAfterwork",
"count": 1,
"sum": 45
},
{
"field": "userstateCall",
"count": null,
"sum": 81
},
{
"field": "callOut",
"count": null,
"sum": 99
}
],
"level": 3
},
{
"date": "2020-06-23",
"time": 1600,
"projectId": 2,
"userId": 17,
"data": [
{
"field": "userstateAvailable",
"count": 1,
"sum": 310
},
{
"field": "dispositionStatusRecall",
"count": 2,
"sum": null
},
{
"field": "dispositionReachFailed",
"count": 3,
"sum": null
},
{
"field": "userstateAfterwork",
"count": 1,
"sum": 10
},
{
"field": "userstateCall",
"count": null,
"sum": 15
},
{
"field": "callOut",
"count": null,
"sum": 44
}
],
"level": 3
}
],
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.