Index

Operators

Path:

{{baseUrl}}/api/v1/{{codename}}/stats/operator?startDate=2021-11-01T03:00:00.000Z&endDate=2021-12-01T02:55:00.000Z

Method: GET

Header:

Accept: 'application/json'
Content-Type: 'application/json'
Authorization: 'Bearer ' + accessToken

URL parameters:

Parameter	type	Description
codename	String	Request the Chat-Tonic team.

Query parameters:

Parameter	type	Description
startDate	String	2021-11-01T03:00:00.000Z
endDate	String	2021-12-01T02:55:00.000Z

Response:

{
    "status": true,
    "operators": [{
            "name": {
                "givenName": "Chamo",
                "familyName": "Sac2"
            },
            "origins": [
                "5ed94dd1fdda89cee4cb61"
            ],
            "profile": 500,
            "_id": "5ed96d95aef725fdfb",
            "displayName": "Chamo Sac2",
            "onlineTime": 0,
            "awayTime": 0,
            "freeTime": 0,
            "queriesResolved": 0,
            "avgDurationResolved": 0,
            "queriesAssigned": 0,
            "sumDuration": 0,
            "nps": 0,
            "lastConnection": null,
            "numberOfResponsesNps": 0,
            "queryInProgress": 0,
            "originsName": "Tengo otro tipo de consultas"
        },
        {
            "name": {
                "givenName": "Chamo",
                "familyName": "Operator"
            },
            "origins": [],
            "profile": 500,
            "_id": "5f286ede4dbdcf209af",
            "displayName": "Chamo Operator",
            "status": "online",
            "onlineTime": 480,
            "awayTime": 0,
            "freeTime": 0,
            "queriesResolved": 0,
            "avgDurationResolved": 0,
            "queriesAssigned": 0,
            "sumDuration": 0,
            "nps": 0,
            "lastConnection": null,
            "numberOfResponsesNps": 0,
            "queryInProgress": 0,
            "originsName": "all"
        }
    ],
    "queryPending": 0
}

NPS

Path:

{{baseUrl}}/api/v1/{{codename}}/stats/nps/export?typeUser=all&startDate=2021-11-01T03:00:00.000Z&endDate=2021-12-01T02:55:00.000Z

Method: GET

Header:

Accept: 'application/json'
Content-Type: 'application/json'
Authorization: 'Bearer ' + accessToken

URL parameters:

Parameter	type	Description
codename	String	Request the Chat-Tonic team.

Query parameters:

Parameter	type	Description
startDate	String	Date string in UTC
endDate	String	Date string in UTC
typeUser	String	all, promoter, passive or detractor

Response:

Sends an email to the attested user with the report attached

Dashboard

Path:

{{baseUrl}}/api/v1/{{codename}}/stats/bigquery?dateFormatGroup=%Y-%m-%d %H&queryName=dashboard&startDate={{startDate}}&endDate={{endDate}}

Method: GET

Header:

Accept: 'application/json'
Content-Type: 'application/json'
Authorization: 'Bearer ' + accessToken

URL parameters:

Parameter	type	Description
codename	String	Request the Chat-Tonic team.

Query parameters:

Parameter	type	Description
startDate	String	Date string in UTC
endDate	String	Date string in UTC

Response:

[{
    "date": "0",
    "totalUsers": 35756,
    "newUsers": 1211,
    "activeUsers": 1564,
    "totalMessagesReceived": 436368,
    "messagesReceived": 17099,
    "totalMessagesSent": 576358,
    "messagesSent": 22424,
    "pending": 0,
    "progress": 0,
    "resolved": 0,
    "failed": 0,
    "userEfficiency": 0,
    "attention": 0,
    "resolution": 0,
    "attentionAndResolution": 0,
    "nps": 0,
    "csat": 0
}]