Skip to main content

Reporting v1.0

Reporting Service

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

metrics-controller

retrieve yearly values for a year range

GET https://auvious.video/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0 HTTP/1.1
Host: auvious.video
Accept: application/json

retrieve yearly values for a year range

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration
startYearqueryinteger(int32)truenone
endYearqueryinteger(int32)truenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[YearlyMetricResult]falsenonenone
» valuenumber(double)falsenonenone
» yearinteger(int32)falsenonenone

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

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

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/yearly/{metric}?startYear=0&endYear=0 \
-H 'Accept: application/json'

retrieve weekly values for a specific year

GET https://auvious.video/api/reporting/metrics/weekly/{metric}?year=0 HTTP/1.1
Host: auvious.video
Accept: */*

retrieve weekly values for a specific year

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration
yearqueryinteger(int32)truenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[WeeklyMetricResult]falsenonenone
» valuenumber(double)falsenonenone
» yearinteger(int32)falsenonenone
» weekinteger(int32)falsenonenone

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/weekly/{metric}?year=0 \
-H 'Accept: */*'

retrieve accumulated values so far

GET https://auvious.video/api/reporting/metrics/total/{metric} HTTP/1.1
Host: auvious.video
Accept: application/json

retrieve accumulated values so far

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKMetricResult
400Bad RequestBad RequestInline
Response Schema

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

{
"value": 0
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/total/{metric} \
-H 'Accept: application/json'

retrieve monthly values for a specific year

GET https://auvious.video/api/reporting/metrics/monthly/{metric}?year=0 HTTP/1.1
Host: auvious.video
Accept: */*

retrieve monthly values for a specific year

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration
yearqueryinteger(int32)truenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[MonthlyMetricResult]falsenonenone
» valuenumber(double)falsenonenone
» yearinteger(int32)falsenonenone
» monthinteger(int32)falsenonenone

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/monthly/{metric}?year=0 \
-H 'Accept: */*'

retrieve hourly values for a specific day

GET https://auvious.video/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1 HTTP/1.1
Host: auvious.video
Accept: */*

retrieve hourly values for a specific day

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration
yearqueryinteger(int32)truenone
monthqueryinteger(int32)truenone
dayqueryinteger(int32)truenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[HourlyMetricResult]falsenonenone
» valuenumber(double)falsenonenone
» yearinteger(int32)falsenonenone
» monthinteger(int32)falsenonenone
» dayinteger(int32)falsenonenone
» hourinteger(int32)falsenonenone

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/hourly/{metric}?year=0&month=1&day=1 \
-H 'Accept: */*'

retrieve daily values for a specific month

GET https://auvious.video/api/reporting/metrics/daily/{metric}?year=0&month=1 HTTP/1.1
Host: auvious.video
Accept: */*

retrieve daily values for a specific month

Parameters

ParameterInTypeRequiredDescription
metricpathstringtruevideo_calls_created, 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_sesssions_performed, cobrowse_sesssions_denied, cobrowse_sesssions_abandoned, cobrowse_control_requested, cobrowse_control_accepted, cobrowse_control_denied, cobrowse_session_duration
yearqueryinteger(int32)truenone
monthqueryinteger(int32)truenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[DailyMetricResult]falsenonenone
» valuenumber(double)falsenonenone
» yearinteger(int32)falsenonenone
» monthinteger(int32)falsenonenone
» dayinteger(int32)falsenonenone

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/metrics/daily/{metric}?year=0&month=1 \
-H 'Accept: */*'

audit-controller

retrieve audit logs

GET https://auvious.video/api/reporting/audits?params=property1,string,property2,string&pageable=page,0,size,1,sort,string HTTP/1.1
Host: auvious.video
Accept: */*

retrieve filtered audit logs

Parameters

ParameterInTypeRequiredDescription
paramsqueryobjecttruenone
pageablequeryPageabletruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKPageAuditLog
400Bad RequestBad RequestInline
Response Schema

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

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

retrieve audit application types

GET https://auvious.video/api/reporting/audits/applications HTTP/1.1
Host: auvious.video
Accept: */*

retrieve available audit application types

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/audits/applications \
-H 'Accept: */*'

retrieve audit action types

GET https://auvious.video/api/reporting/audits/actions HTTP/1.1
Host: auvious.video
Accept: */*

retrieve available audit action types

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
400Bad RequestBad RequestInline
Response Schema

Status Code 400

NameTypeRequiredRestrictionsDescription
» additionalPropertiesobjectfalsenonenone
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Jwt Bearer Token, Client Credentials

Code samples

curl -X GET https://auvious.video/api/reporting/audits/actions \
-H 'Accept: */*'

Schemas

YearlyMetricResult

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

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone
yearinteger(int32)falsenonenone

WeeklyMetricResult

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

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone
yearinteger(int32)falsenonenone
weekinteger(int32)falsenonenone

MetricResult

{
"value": 0
}

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone

MonthlyMetricResult

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

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone
yearinteger(int32)falsenonenone
monthinteger(int32)falsenonenone

HourlyMetricResult

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

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone
yearinteger(int32)falsenonenone
monthinteger(int32)falsenonenone
dayinteger(int32)falsenonenone
hourinteger(int32)falsenonenone

DailyMetricResult

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

Properties

NameTypeRequiredRestrictionsDescription
valuenumber(double)falsenonenone
yearinteger(int32)falsenonenone
monthinteger(int32)falsenonenone
dayinteger(int32)falsenonenone

Pageable

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

Properties

NameTypeRequiredRestrictionsDescription
pageinteger(int32)falsenonenone
sizeinteger(int32)falsenonenone
sort[string]falsenonenone

AuditEvent

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

Properties

NameTypeRequiredRestrictionsDescription
timeStampstringfalsenonenone
interactionIdstringfalsenonenone
organizationIdstringfalsenonenone
userIdstringfalsenonenone
roles[string]falsenonenone
actionstringfalsenonenone
outcomestringfalsenonenone
applicationstringfalsenonenone
detailstringfalsenonenone
Enumerated Values
PropertyValue
actionCREATE
actionCANCEL
actionRE_EXECUTE
actionURL_ATTACHMENT
actionURL_INLINE
actionSTART
actionSTOP
actionUPDATE
actionDELETE
actionAPPOINTMENT_RE_SCHEDULE
actionAPPOINTMENT_RE_ASSIGN
actionASR_ADD_LANGUAGE
actionASR_REMOVE_LANGUAGE
actionASR_ADD_TRANSLATION_LANGUAGE
actionASR_REMOVE_TRANSLATION_LANGUAGE
outcomeSUCCESS
outcomeFAIL
applicationRECORDING
applicationCOMPOSITION
applicationAPPOINTMENT
applicationAPPLICATION
applicationASR

AuditLog

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

Properties

NameTypeRequiredRestrictionsDescription
auditAuditEventfalsenonenone

PageAuditLog

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

Properties

NameTypeRequiredRestrictionsDescription
totalPagesinteger(int32)falsenonenone
totalElementsinteger(int64)falsenonenone
sizeinteger(int32)falsenonenone
content[AuditLog]falsenonenone
numberinteger(int32)falsenonenone
sortSortfalsenonenone
pageablePageableObjectfalsenonenone
numberOfElementsinteger(int32)falsenonenone
firstbooleanfalsenonenone
lastbooleanfalsenonenone
emptybooleanfalsenonenone

PageableObject

{
"offset": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"unpaged": true
}

Properties

NameTypeRequiredRestrictionsDescription
offsetinteger(int64)falsenonenone
sortSortfalsenonenone
pageNumberinteger(int32)falsenonenone
pageSizeinteger(int32)falsenonenone
pagedbooleanfalsenonenone
unpagedbooleanfalsenonenone

Sort

{
"empty": true,
"sorted": true,
"unsorted": true
}

Properties

NameTypeRequiredRestrictionsDescription
emptybooleanfalsenonenone
sortedbooleanfalsenonenone
unsortedbooleanfalsenonenone