Analytics

The MediaVault API offers multiple endpoints to retrieve analytics based on various identifiers. You can access metadata using a reference ID, session ID, master ID, or call ID. These endpoints provide flexibility in managing and retrieving analytics within your application.

GET /analytics/transcript-by-reference/{ref_id}

Retrieve recording transcript based on reference_id / session_id / master_id

Required Parameters

ref_id string

reference_id / session_id / master_id of the associated metadata / recording

Request

curl -X 'GET' \
    'https://api.mediavaultplus.com/analytics/transcript-by-reference/123456789' \
    -H 'accept: application/json'

Response


{
    "isError": false,
    "errorMessage": null,
    "data": {
            "call_id": "123456789",
            "ref_id": "123456789",
            "transcript": "Hi. My name is John Doe. How can I help you? Hey, Jane Doe. My credit Card number is #####. It is lost. I want to deactivate my card.",
            "labels": null
    }
}

GET /analytics/speaker-labels-by-call-id/{call_id}

Retrieve recording transcript along with speaker labels based on call_id

Required Parameters

call_id string

call_id of the associated metadata / recording

Request

curl -X 'GET' \
    'https://api.mediavaultplus.com/analytics/transcript-by-reference/123456789' \
    -H 'accept: application/json'

Response


{
    "isError": false,
    "errorMessage": null,
    "data": {
            "call_id": "123456789",
            "ref_id": "123456789",
            "transcript": "Hi. My name is John Doe. How can I help you? Hey, Jane Doe. My credit Card number is #####. It is lost. I want to deactivate my card.",
            "labels": null
    }
}

GET /analytics/speaker-labels-by-reference/{ref_id}

Retrieve recording transcript along with speaker labels based on reference_id / session_id / master_id

Required Parameters

ref_id string

Retrieve recording transcript along with speaker labels based on ref_id

Request

curl -X 'POST' \
    'https://api.mediavaultplus.com/analytics/speaker-labels-by-reference/123465789' \
    -H 'accept: application/json'

Response


{
    "isError": false,
    "errorMessage": null,
    "data": {
        "call_id": "123465789",
        "ref_id": "123456789",
        "transcript": "Hi. My name is John Doe. How can I help you? Hey, John Doe. My credit Card number is #####. It is lost. I want to deactivate my card.",
        "labels": [
            {
                "start_time": "00:00:01.215",
                "end_time": "00:00:03.715",
                "speaker": "A",
                "text": "Hi. My name is John Doe. How can I help you?"
            },
            {
                "start_time": "00:00:04.055",
                "end_time": "00:00:41.135",
                "speaker": "B",
                "text": "Hey, John Doe. My credit Card number is #####. It is lost. I want to deactivate my card."
            }
        ]
    }
}

GET /analytics/speaker-labels-by-call-id/{call_id}

Retrieve recording transcript along with speaker labels based on csmallid

Required Parameters

call_id string

Retrieve recording transcript along with speaker labels based on call_id

Request

curl -X 'POST' \
    'https://api.mediavaultplus.com/analytics/speaker-labels-by-call-id/123465789' \
    -H 'accept: application/json'

Response


{
    "isError": false,
    "errorMessage": null,
    "data": {
        "call_id": "123465789",
        "ref_id": "123456789",
        "transcript": "Hi. My name is John Doe. How can I help you? Hey, John Doe. My credit Card number is #####. It is lost. I want to deactivate my card.",
        "labels": [
            {
                "start_time": "00:00:01.215",
                "end_time": "00:00:03.715",
                "speaker": "A",
                "text": "Hi. My name is John Doe. How can I help you?"
            },
            {
                "start_time": "00:00:04.055",
                "end_time": "00:00:41.135",
                "speaker": "B",
                "text": "Hey, John Doe. My credit Card number is #####. It is lost. I want to deactivate my card."
            }
        ]
    }
}