API Metadata Guide

Using Metadata with Beyond Verbal REST API

Metadata field of the START request allows to attach arbitrary information to each analysis session.

Most common usage of the metadata field is to uniquely identify particular user, device or group of users for later aggregated analysis.

Examples of unique identifiers are: email address, mobile phone number, physical (manufacturer) device ID, facebookId, twitter ID.

Set the clientId field value to your unique identifier. Example

POST https://apiv3.beyondverbal.com/api/v3/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
“dataFormat”: {“type”: “WAV”},
“metadata”:{“clientId” : “+991199483679”}
}

Optionally you can also set this id as additional field of metadata object in order to specify it’s origin

Field  
email Client email
phone Client phone (mobile)
deviceId Physical device ID
facebookId Facebook Id
trwitterId Twitter Id


Example where clientId is a phone number:


POST https://apiv3.beyondverbal.com/api/v3/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
  “dataormat”: {“type”: “WAV”},
  “metadata”:{“clientId”: “+991199483679”, “phone” : “+991199483679”}
}


Example where the clientId is email:

POST https://apiv3.beyondverbal.com/api/v3/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
    “dataormat”: {“type”: “WAV”},
     “metadata”:{
          “clientId”: “someone@someplace.com”,
            “email” : “someone@someplace.com”
      }
}