Get custom VOC report result

GET

/voc/custom/reports/{reportId}

Request

Path Params

reportId

string

required

Report ID

Example:

123456789

Header Params

X-Token

string

required

API Key

Example:

42e9fb1c94c842cd9495c812a4c8fe05

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://apps.voc.ai/api_v2/datahub//voc/custom/reports/123456789' \
--header 'X-Token: 42e9fb1c94c842cd9495c812a4c8fe05'

Responses

🟢200成功

application/json

Body

code

string

required

Result code

msg

string

optional

Error message

data

object

optional

Result data

finish

boolean

required

Is report finish

list

array [object {2}]

required

Tag detail data

statistics

array [object {5}]

required

Tag statistic data

Example

{
  "code": 200,
  "msg": "success",
  "data": {
    "finish": true,
    "list": [
      {
        "text": "I would have to say that I am very disappointed on this product. After reviewing all the reviews I found it ideal to order one because, after all black goes with everything, especially from working out you wont be able to see the stains. Now I have to say that when I placed it on my Fitbit Versa I was having trouble putting it on and after all the pin broke and the pin was left inside. Idk if it's because it's not from the manufacturer but I was overall disappointed.",
        "tags": [
          {
            "tag": "Customer Service",
            "sentiment": 0,
            "startOffset": 65,
            "endOffset": 134,
            "tagType": "reason",
            "subTag": "Positive Reviews"
          },
          {
            "tag": "Defective Pin",
            "sentiment": -1,
            "startOffset": 336,
            "endOffset": 388,
            "tagType": "cons",
            "subTag": "Defective Pin"
          }
        ]
      }
    ],
    "statistics": [
      {
        "type": "Usage Scenario",
        "reasons": "The headset is considered a good gift option, with many users reporting that it makes a great birthday gift or gift for a son.",
        "percent": "0.08",
        "tag": "Gift"
      }
    ]
  }
}

Modified at 2024-01-26 08:09:24

Create custom VOC report