Reporting API v1.1.4-beta.5

Reporting API

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

• OAuth 2.0 Authorization. Authenticate using Client Credentials

  • Flow: clientCredentials

  • OAuth 2.0 Token URL = http://localhost:8080/security/oauth/token

  • OAuth 2.0 Scope

    Scope	Scope Description

• HTTP Authentication, scheme: Bearer Jwt Bearer Token Access

metrics-controller

retrieve yearly values for a year range

GET http://localhost:8080/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0 HTTP/1.1
Host: localhost:8080
Accept: application/json

retrieve yearly values for a year range

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
startYear	query	integer(int32)	true	none
endYear	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[YearlyMetricResult]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

[
  {
    "value": 0.1,
    "year": 0
  }
]

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0 \
  -H 'Accept: application/json'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/yearly/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': 'application/json'
}

fetch('http://localhost:8080/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/yearly/{metric}',
  params={
    'startYear': '0',
    'endYear': '0'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/yearly/{metric}',
  params: {
    'startYear' => 'integer(int32)',
    'endYear' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve weekly values for a specific year

GET http://localhost:8080/api/reporting/metrics/weekly/{metric}?year=0 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve weekly values for a specific year

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[WeeklyMetricResult]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» week	integer(int32)	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/weekly/{metric}?year=0 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/weekly/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/weekly/{metric}?year=0', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/weekly/{metric}?year=0");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/weekly/{metric}',
  params={
    'year': '0'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/weekly/{metric}',
  params: {
    'year' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve accumulated values so far

GET http://localhost:8080/api/reporting/metrics/total/{metric} HTTP/1.1
Host: localhost:8080
Accept: application/json

retrieve accumulated values so far

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	MetricResult
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

{
  "value": 0.1
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/total/{metric} \
  -H 'Accept: application/json'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/total/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': 'application/json'
}

fetch('http://localhost:8080/api/reporting/metrics/total/{metric}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/total/{metric}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/total/{metric}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/total/{metric}',
  params: {}, headers: headers

p JSON.parse(result)

retrieve monthly values for a specific year

GET http://localhost:8080/api/reporting/metrics/monthly/{metric}?year=0 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve monthly values for a specific year

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[MonthlyMetricResult]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» month	integer(int32)	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/monthly/{metric}?year=0 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/monthly/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/monthly/{metric}?year=0', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/monthly/{metric}?year=0");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/monthly/{metric}',
  params={
    'year': '0'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/monthly/{metric}',
  params: {
    'year' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve monthly values for all organizations (internal use)

GET http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}?year=0&month=1 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve monthly values for all organizations (internal use)

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none
month	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[MonthlyMetricResultWithOrganization]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» month	integer(int32)	false	none	none
» organizationId	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}?year=0&month=1 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}?year=0&month=1', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}?year=0&month=1");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}',
  params={
    'year': '0',
    'month': '1'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/internal/monthly/{metric}',
  params: {
    'year' => 'integer(int32)',
    'month' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve daily values for all organizations (internal use)

GET http://localhost:8080/api/reporting/metrics/internal/daily/{metric}?year=0&month=1&day=1 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve daily values for all organizations (internal use)

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none
month	query	integer(int32)	true	none
day	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DailyMetricResultWithOrganization]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» month	integer(int32)	false	none	none
» day	integer(int32)	false	none	none
» organizationId	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/internal/daily/{metric}?year=0&month=1&day=1 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/internal/daily/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/internal/daily/{metric}?year=0&month=1&day=1', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/internal/daily/{metric}?year=0&month=1&day=1");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/internal/daily/{metric}',
  params={
    'year': '0',
    'month': '1',
    'day': '1'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/internal/daily/{metric}',
  params: {
    'year' => 'integer(int32)',
    'month' => 'integer(int32)',
    'day' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve hourly values for a specific day

GET http://localhost:8080/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve hourly values for a specific day

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none
month	query	integer(int32)	true	none
day	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[HourlyMetricResult]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» month	integer(int32)	false	none	none
» day	integer(int32)	false	none	none
» hour	integer(int32)	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/hourly/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/hourly/{metric}',
  params={
    'year': '0',
    'month': '1',
    'day': '1'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/hourly/{metric}',
  params: {
    'year' => 'integer(int32)',
    'month' => 'integer(int32)',
    'day' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

retrieve daily values for a specific month

GET http://localhost:8080/api/reporting/metrics/daily/{metric}?year=0&month=1 HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve daily values for a specific month

Parameters

Parameter	In	Type	Required	Description
metric	path	string	true	video_calls_created, video_calls, interactions_created, ratings_submitted, rating_score_average, concurrent_calls_max, concurrent_calls_avg, conference_average_duration, call_average_duration, video_calls_performed, video_calls_abandoned, video_calls_with_small_duration, video_calls_with_normal_duration, video_calls_with_long_duration, cobrowse_sessions_created, cobrowse_sessions_performed, cobrowse_sessions_denied, cobrowse_sessions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration, users_authenticated
year	query	integer(int32)	true	none
month	query	integer(int32)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DailyMetricResult]	false	none	none
» value	number(double)	false	none	none
» year	integer(int32)	false	none	none
» month	integer(int32)	false	none	none
» day	integer(int32)	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	object	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/metrics/daily/{metric}?year=0&month=1 \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/metrics/daily/{metric}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/metrics/daily/{metric}?year=0&month=1', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/metrics/daily/{metric}?year=0&month=1");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/metrics/daily/{metric}',
  params={
    'year': '0',
    'month': '1'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/metrics/daily/{metric}',
  params: {
    'year' => 'integer(int32)',
    'month' => 'integer(int32)'}, headers: headers

p JSON.parse(result)

audit-controller

retrieve audit logs

GET http://localhost:8080/api/reporting/audits?params=property1,string,property2,string&pageable=page,0,size,1,sort,string HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve filtered audit logs

Parameters

Parameter	In	Type	Required	Description
params	query	object	true	none
pageable	query	Pageable	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	PageAuditLog

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/audits?params=property1,string,property2,string&pageable=page,0,size,1,sort,string \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/audits", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/audits?params=property1,string,property2,string&pageable=page,0,size,1,sort,string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/audits?params=property1,string,property2,string&pageable=page,0,size,1,sort,string");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/audits',
  params={
    'params': {
  "property1": "string",
  "property2": "string"
},
    'pageable': {
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/audits',
  params: {
    'params' => 'object',
    'pageable' => '[Pageable](#schemapageable)'}, headers: headers

p JSON.parse(result)

retrieve audit application types

GET http://localhost:8080/api/reporting/audits/applications HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve available audit application types

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/audits/applications \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/audits/applications", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/audits/applications', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/audits/applications");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/audits/applications',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/audits/applications',
  params: {}, headers: headers

p JSON.parse(result)

retrieve audit action types

GET http://localhost:8080/api/reporting/audits/actions HTTP/1.1
Host: localhost:8080
Accept: */*

retrieve available audit action types

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET http://localhost:8080/api/reporting/audits/actions \
  -H 'Accept: */*'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:8080/api/reporting/audits/actions", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

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

const headers = {
  'Accept': '*/*'
}

fetch('http://localhost:8080/api/reporting/audits/actions', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("http://localhost:8080/api/reporting/audits/actions");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*'
}

r = requests.get(
  'http://localhost:8080/api/reporting/audits/actions',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'http://localhost:8080/api/reporting/audits/actions',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

YearlyMetricResult

{
  "value": 0.1,
  "year": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none

WeeklyMetricResult

{
  "value": 0.1,
  "year": 0,
  "week": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
week	integer(int32)	false	none	none

MetricResult

{
  "value": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none

MonthlyMetricResult

{
  "value": 0.1,
  "year": 0,
  "month": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
month	integer(int32)	false	none	none

MonthlyMetricResultWithOrganization

{
  "value": 0.1,
  "year": 0,
  "month": 0,
  "organizationId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
month	integer(int32)	false	none	none
organizationId	string	false	none	none

DailyMetricResultWithOrganization

{
  "value": 0.1,
  "year": 0,
  "month": 0,
  "day": 0,
  "organizationId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
month	integer(int32)	false	none	none
day	integer(int32)	false	none	none
organizationId	string	false	none	none

HourlyMetricResult

{
  "value": 0.1,
  "year": 0,
  "month": 0,
  "day": 0,
  "hour": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
month	integer(int32)	false	none	none
day	integer(int32)	false	none	none
hour	integer(int32)	false	none	none

DailyMetricResult

{
  "value": 0.1,
  "year": 0,
  "month": 0,
  "day": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	number(double)	false	none	none
year	integer(int32)	false	none	none
month	integer(int32)	false	none	none
day	integer(int32)	false	none	none

Pageable

{
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
page	integer(int32)	false	none	none
size	integer(int32)	false	none	none
sort	[string]	false	none	none

AuditEvent

{
  "timeStamp": "string",
  "interactionId": "string",
  "organizationId": "string",
  "applicationId": "string",
  "userId": "string",
  "roles": [
    "string"
  ],
  "action": "CREATE",
  "outcome": "SUCCESS",
  "application": "RECORDING",
  "detail": "string"
}

Properties

Name	Type	Required	Restrictions	Description
timeStamp	string	false	none	none
interactionId	string	false	none	none
organizationId	string	false	none	none
applicationId	string	false	none	none
userId	string	false	none	none
roles	[string]	false	none	none
action	string	false	none	none
outcome	string	false	none	none
application	string	false	none	none
detail	string	false	none	none

Enumerated Values

Property	Value
action	CREATE
action	CANCEL
action	RE_EXECUTE
action	URL_ATTACHMENT
action	URL_INLINE
action	START
action	STOP
action	UPDATE
action	DELETE
action	ACTIVATE
action	APPOINTMENT_RE_SCHEDULE
action	APPOINTMENT_RE_ASSIGN
action	ASR_ADD_LANGUAGE
action	ASR_REMOVE_LANGUAGE
action	ASR_ADD_TRANSLATION_LANGUAGE
action	ASR_REMOVE_TRANSLATION_LANGUAGE
outcome	SUCCESS
outcome	FAIL
application	RECORDING
application	COMPOSITION
application	APPOINTMENT
application	APPLICATION
application	ASR
application	WEBHOOK

AuditLog

{
  "audit": {
    "timeStamp": "string",
    "interactionId": "string",
    "organizationId": "string",
    "applicationId": "string",
    "userId": "string",
    "roles": [
      "string"
    ],
    "action": "CREATE",
    "outcome": "SUCCESS",
    "application": "RECORDING",
    "detail": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
audit	AuditEvent	false	none	none

PageAuditLog

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "audit": {
        "timeStamp": "string",
        "interactionId": "string",
        "organizationId": "string",
        "applicationId": "string",
        "userId": "string",
        "roles": [
          "string"
        ],
        "action": "CREATE",
        "outcome": "SUCCESS",
        "application": "RECORDING",
        "detail": "string"
      }
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "string",
        "nullHandling": "string",
        "ascending": true,
        "property": "string",
        "ignoreCase": true
      }
    ],
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "empty": true
}

Properties

Name	Type	Required	Restrictions	Description
totalElements	integer(int64)	false	none	none
totalPages	integer(int32)	false	none	none
first	boolean	false	none	none
last	boolean	false	none	none
size	integer(int32)	false	none	none
content	[AuditLog]	false	none	none
number	integer(int32)	false	none	none
sort	[SortObject]	false	none	none
numberOfElements	integer(int32)	false	none	none
pageable	PageableObject	false	none	none
empty	boolean	false	none	none

PageableObject

{
  "offset": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "paged": true,
  "pageNumber": 0,
  "pageSize": 0,
  "unpaged": true
}

Properties

Name	Type	Required	Restrictions	Description
offset	integer(int64)	false	none	none
sort	[SortObject]	false	none	none
paged	boolean	false	none	none
pageNumber	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none
unpaged	boolean	false	none	none

SortObject

{
  "direction": "string",
  "nullHandling": "string",
  "ascending": true,
  "property": "string",
  "ignoreCase": true
}

Properties

Name	Type	Required	Restrictions	Description
direction	string	false	none	none
nullHandling	string	false	none	none
ascending	boolean	false	none	none
property	string	false	none	none
ignoreCase	boolean	false	none	none