TSGGLOBAL Support sign in
Skip to page content
Browse TNID API docs

TNID API documentation Company Message sentiment analysis Get Sentiment Analysis Result

Get Sentiment Analysis Result

On this page

GraphQL endpoint: /company

Gets a single sentiment analysis result by ID, including the analyzed external communication. Only results for the company's own communications are accessible.

Query

query ($id: ID!) {
  sentimentAnalysisResult(id: $id) {
    id
    action
    certaintyFactor
    topics
    externalCommunication {
      id
      hostAddress
      remoteAddress
      messageBody
      type
      direction
    }
  }
}

Variables

{
  "id": "00000000-0000-4000-8000-000000000002"
}

Response

{
  "data": {
    "sentimentAnalysisResult": {
      "action": "SUBSCRIBE",
      "certaintyFactor": 0.9,
      "externalCommunication": {
        "direction": "INBOUND",
        "hostAddress": "1",
        "id": "00000000-0000-4000-8000-000000000001",
        "messageBody": "This is a test message",
        "remoteAddress": "1",
        "type": "SMS"
      },
      "id": "00000000-0000-4000-8000-000000000002",
      "topics": [
        "opt-out"
      ]
    }
  }
}