Alvaria Cloud Reporting REST API v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Alvaria™ Cloud Omni Reporting Real-Time Data Query API (query API) provides a RESTFUL approach to extract data from the Alvaria™ Cloud Real-Time Reporting platform. Each query (REST endpoint) is a representation of a specific view of the data within the real-time reporting platform. When accessed by the client, the results provide a snapshot of the data being requested, at that point in time. In order to utilize the Reporting APIs the reportingapi scope is required.

Base URLs:

• https://orgId.via.aspect-cloud.net

License: License: Creative Commons Attribution 4.0 International Public License

Authentication

• oAuth2 authentication.

  • Flow: client crendentials
  • Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token

Data

Get ListActivity

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/listActivity/data?contactList=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/listActivity/data?contactList=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/listActivity/data?contactList=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/reporting/queries/listActivity/data

This operation returns the following List Activity Statistics:- recordsAvailable - Records available to dial - recordsAttempted - Records that were dialled at least once - recordsInActive - Records that are with the dialler - callsBusy - Records that must be re-attempted - listPenetration - Percentage of records that have been dialed at least once. - listSaturation - Saturation is the number of contact attempts divided by the number of records attempted (as a percentage) - passcountPenetration - Percentage of records that have been dialed at least once for the dynamic list - passcountSaturation - Saturation is the number of contact attempts divided by the number of records attempted (as a percentage) for the dynamic lists

Parameters

Example responses

200 Response

{
  "kind": "via#listActivity",
  "contactList": "ContactList1",
  "recordsAvailable": 100,
  "recordsAttempted": 100,
  "recordsInActive": 100,
  "callsBusy": 25,
  "passcountPenetration": 30,
  "passcountSaturation": 70,
  "listPenetration": 70,
  "listSaturation": 40
}

Responses

Get teamActivity

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/teamActivity/data?teamId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/teamActivity/data?teamId=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/teamActivity/data?teamId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/reporting/queries/teamActivity/data

Gets the current snapshot of activity metrics for the team instance that was requested. Note: If you see any success response with 0 rows, it might be team manager/owner not in the requested team.

Parameters

Example responses

200 Response

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "teamId": "salesTeam",
      "teamName": "Sales Team",
      "notReadyCount": 0,
      "parkCount": 0,
      "parkWarningCount": 0,
      "idleCount": 1,
      "pendingActiveCount": 0,
      "activeCount": 0,
      "wrapCount": 0,
      "wrapWarningCount": 0,
      "multiLineCount": 0,
      "holdCount": 0,
      "previewCount": 0
    }
  ]
}

Responses

Get userActivity

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/userActivity/data?teamId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/userActivity/data?teamId=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/userActivity/data?teamId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/reporting/queries/userActivity/data

Gets the current snapshot of user activity metrics for the team instance that was requested. Note: If you see any success response with 0 rows, it might be team manager/owner not in the requested team.

Parameters

Example responses

200 Response

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "userId": "Keran123",
      "teamId": "salseTeam",
      "preferredName": "Keran Bloggs",
      "teamName": "Sales team",
      "signOnTime": "2018-02-07T11:29:46Z",
      "stateId": "active",
      "stateName": "Active",
      "stateStartTime": "2018-02-07T11:29:46Z",
      "reasonId": "break",
      "reasonName": "",
      "interactionCount": 1,
      "signOnTimeLocal": "2018-02-07T11:29:46-07:00",
      "stateStartTimeLocal": "2018-02-07T11:29:46-07:00",
      "stateDur": 5,
      "signOnDur": 664
    }
  ]
}

Responses

Get channelActivity

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/channelActivity/data?workTypeId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/channelActivity/data?workTypeId=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/queries/channelActivity/data?workTypeId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/reporting/queries/channelActivity/data

Gets the current snapshot of channel activity metrics for the Worktype instance that was requested.

Parameters

Example responses

200 Response

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "interactionTypeId": "InboundEmail",
      "channelTypeId": "email",
      "workTypeId": "worktype30_id",
      "interactionTypeName": "Inbound Email",
      "channelTypeName": "Email",
      "workTypeName": "workType30",
      "dialCount": 0,
      "activeCount": 0,
      "queueCount": 0,
      "selfServiceCount": 0,
      "previewCount": 0,
      "holdCount": 0,
      "inactiveCount": 0,
      "wrapCount": 0,
      "ringCount": 0,
      "longestWaitingQueueTime": "2018-02-07T11:29:46Z",
      "selfServiceDur": 5,
      "queueDur": 5,
      "activeDur": 0,
      "previewDur": 0,
      "maxQueueDur": 0
    }
  ]
}

Responses

Get usersList

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/presence/users/data?state=LoggedOn \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/presence/users/data?state=LoggedOn',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/reporting/presence/users/data?state=LoggedOn HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/reporting/presence/users/data

Used to get a list of logged in users associated with a workType and also used to get the list of logged in users regardless of workType.

Parameters

Enumerated Values

Example responses

200 Response

{
  "kind": "via#presenceDataList",
  "users": [
    {
      "userId": "Keran123",
      "firstName": "Mahesh",
      "lastName": "Kumar",
      "ehubSessionId": 2323,
      "emailAddress": "agent@alvaria.com"
    }
  ],
  "totalItems": 1
}

Responses

Response Headers

Schemas

CollectionListActivityResponse

{
  "kind": "via#listActivity",
  "contactList": "ContactList1",
  "recordsAvailable": 100,
  "recordsAttempted": 100,
  "recordsInActive": 100,
  "callsBusy": 25,
  "passcountPenetration": 30,
  "passcountSaturation": 70,
  "listPenetration": 70,
  "listSaturation": 40
}

Properties

teamActivity

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "teamId": "salesTeam",
      "teamName": "Sales Team",
      "notReadyCount": 0,
      "parkCount": 0,
      "parkWarningCount": 0,
      "idleCount": 1,
      "pendingActiveCount": 0,
      "activeCount": 0,
      "wrapCount": 0,
      "wrapWarningCount": 0,
      "multiLineCount": 0,
      "holdCount": 0,
      "previewCount": 0
    }
  ]
}

Properties

teamActivityRows

{
  "teamId": "salesTeam",
  "teamName": "Sales Team",
  "notReadyCount": 0,
  "parkCount": 0,
  "parkWarningCount": 0,
  "idleCount": 1,
  "pendingActiveCount": 0,
  "activeCount": 0,
  "wrapCount": 0,
  "wrapWarningCount": 0,
  "multiLineCount": 0,
  "holdCount": 0,
  "previewCount": 0
}

Properties

userActivity

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "userId": "Keran123",
      "teamId": "salseTeam",
      "preferredName": "Keran Bloggs",
      "teamName": "Sales team",
      "signOnTime": "2018-02-07T11:29:46Z",
      "stateId": "active",
      "stateName": "Active",
      "stateStartTime": "2018-02-07T11:29:46Z",
      "reasonId": "break",
      "reasonName": "",
      "interactionCount": 1,
      "signOnTimeLocal": "2018-02-07T11:29:46-07:00",
      "stateStartTimeLocal": "2018-02-07T11:29:46-07:00",
      "stateDur": 5,
      "signOnDur": 664
    }
  ]
}

Properties

userActivityRow

{
  "userId": "Keran123",
  "teamId": "salseTeam",
  "preferredName": "Keran Bloggs",
  "teamName": "Sales team",
  "signOnTime": "2018-02-07T11:29:46Z",
  "stateId": "active",
  "stateName": "Active",
  "stateStartTime": "2018-02-07T11:29:46Z",
  "reasonId": "break",
  "reasonName": "",
  "interactionCount": 1,
  "signOnTimeLocal": "2018-02-07T11:29:46-07:00",
  "stateStartTimeLocal": "2018-02-07T11:29:46-07:00",
  "stateDur": 5,
  "signOnDur": 664
}

Properties

Enumerated Values

channelActivity

{
  "kind": "via#queryDataList",
  "totalItems": 2,
  "rows": [
    {
      "interactionTypeId": "InboundEmail",
      "channelTypeId": "email",
      "workTypeId": "worktype30_id",
      "interactionTypeName": "Inbound Email",
      "channelTypeName": "Email",
      "workTypeName": "workType30",
      "dialCount": 0,
      "activeCount": 0,
      "queueCount": 0,
      "selfServiceCount": 0,
      "previewCount": 0,
      "holdCount": 0,
      "inactiveCount": 0,
      "wrapCount": 0,
      "ringCount": 0,
      "longestWaitingQueueTime": "2018-02-07T11:29:46Z",
      "selfServiceDur": 5,
      "queueDur": 5,
      "activeDur": 0,
      "previewDur": 0,
      "maxQueueDur": 0
    }
  ]
}

Properties

channelActivityRow

{
  "interactionTypeId": "InboundEmail",
  "channelTypeId": "email",
  "workTypeId": "worktype30_id",
  "interactionTypeName": "Inbound Email",
  "channelTypeName": "Email",
  "workTypeName": "workType30",
  "dialCount": 0,
  "activeCount": 0,
  "queueCount": 0,
  "selfServiceCount": 0,
  "previewCount": 0,
  "holdCount": 0,
  "inactiveCount": 0,
  "wrapCount": 0,
  "ringCount": 0,
  "longestWaitingQueueTime": "2018-02-07T11:29:46Z",
  "selfServiceDur": 5,
  "queueDur": 5,
  "activeDur": 0,
  "previewDur": 0,
  "maxQueueDur": 0
}

Properties

Enumerated Values

ErrorResponse

{
  "error": "Bad Request"
}

Properties

ErrorResponseObj

{
  "code": 404,
  "message": "Not Found",
  "errors": "errors"
}

Properties

ErrorResponseItem

{
  "scope": "scope",
  "reason": "reason",
  "message": "message"
}

Properties

UsersCollection

{
  "kind": "via#presenceDataList",
  "users": [
    {
      "userId": "Keran123",
      "firstName": "Mahesh",
      "lastName": "Kumar",
      "ehubSessionId": 2323,
      "emailAddress": "agent@alvaria.com"
    }
  ],
  "totalItems": 1
}

Properties

userRow

{
  "userId": "Keran123",
  "firstName": "Mahesh",
  "lastName": "Kumar",
  "ehubSessionId": 2323,
  "emailAddress": "agent@alvaria.com"
}

userRow

Properties