Analytics apiQuery

Query Semantic Threads

POST
/query/semantic-threads

Authorization

AuthorizationRequiredBearer <token>

The API key for a Web integration

In: header

AuthorizationRequiredBearer <token>

The API key for an API integration

In: header

Request Body

application/jsonRequired

Note: The maximum size of the request body is 2 MB.

selectarray<SemanticThreadSelection>
groupByarray<SemanticThreadGroupBy>
whereSemanticThreadFilter
orderByarray<SemanticThread OrderBy Schema>
notesstring

Notes are not persisted, but may be useful for your debugging purposes

Maximum length: 80
curl -X POST "https://api.analytics.inkeep.com/query/semantic-threads" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "select": [
      {
        "type": "aggregation",
        "aggregation": "sum",
        "field": "id"
      }
    ],
    "groupBy": [
      {
        "field": "id",
        "includeInSelect": true
      }
    ],
    "where": {
      "condition": {
        "field": "id",
        "operator": "eq",
        "value": "string"
      }
    },
    "orderBy": [
      {
        "field": "id",
        "direction": "asc"
      }
    ],
    "notes": "Count of chat sessions with documentation gaps by integration"
  }'

Query Semantic Threads result

{
  "status": "ok",
  "data": {
    "result": [
      {
        "id": "string",
        "messageIds": null,
        "messagesCount": null,
        "organizationId": "string",
        "question": "string",
        "questionLength": null,
        "answer": "string",
        "isOnTopic": null,
        "isClear": null,
        "isDocumented": null,
        "isFeatureSupported": null,
        "isAnswerConfident": null,
        "gapSummary": null,
        "subject": null,
        "category": null,
        "languages": null,
        "firstPartyEntities": null,
        "thirdPartyEntities": null,
        "emotion": null,
        "sentiment": null,
        "questionType": null,
        "projectId": "string",
        "integrationId": "string",
        "firstMessageTime": "2019-08-24T14:15:22Z",
        "lastMessageTime": "2019-08-24T14:15:22Z",
        "lastUpdated": "2019-08-24T14:15:22Z",
        "hasPositiveFeedback": true,
        "hasNegativeFeedback": true,
        "conversationIds": [
          "string"
        ],
        "areAIAnnotationsVerified": null,
        "isInitialQuestionAnswer": true,
        "sum": 0,
        "count": 0,
        "avg": 0,
        "min": 0,
        "max": 0,
        "id_hour": "string",
        "id_day": "string",
        "id_week": "string",
        "id_month": "string",
        "messageIds_hour": "string",
        "messageIds_day": "string",
        "messageIds_week": "string",
        "messageIds_month": "string",
        "messagesCount_hour": "string",
        "messagesCount_day": "string",
        "messagesCount_week": "string",
        "messagesCount_month": "string",
        "organizationId_hour": "string",
        "organizationId_day": "string",
        "organizationId_week": "string",
        "organizationId_month": "string",
        "question_hour": "string",
        "question_day": "string",
        "question_week": "string",
        "question_month": "string",
        "questionLength_hour": "string",
        "questionLength_day": "string",
        "questionLength_week": "string",
        "questionLength_month": "string",
        "answer_hour": "string",
        "answer_day": "string",
        "answer_week": "string",
        "answer_month": "string",
        "isOnTopic_hour": "string",
        "isOnTopic_day": "string",
        "isOnTopic_week": "string",
        "isOnTopic_month": "string",
        "isClear_hour": "string",
        "isClear_day": "string",
        "isClear_week": "string",
        "isClear_month": "string",
        "isDocumented_hour": "string",
        "isDocumented_day": "string",
        "isDocumented_week": "string",
        "isDocumented_month": "string",
        "isFeatureSupported_hour": "string",
        "isFeatureSupported_day": "string",
        "isFeatureSupported_week": "string",
        "isFeatureSupported_month": "string",
        "isAnswerConfident_hour": "string",
        "isAnswerConfident_day": "string",
        "isAnswerConfident_week": "string",
        "isAnswerConfident_month": "string",
        "gapSummary_hour": "string",
        "gapSummary_day": "string",
        "gapSummary_week": "string",
        "gapSummary_month": "string",
        "subject_hour": "string",
        "subject_day": "string",
        "subject_week": "string",
        "subject_month": "string",
        "category_hour": "string",
        "category_day": "string",
        "category_week": "string",
        "category_month": "string",
        "languages_hour": "string",
        "languages_day": "string",
        "languages_week": "string",
        "languages_month": "string",
        "firstPartyEntities_hour": "string",
        "firstPartyEntities_day": "string",
        "firstPartyEntities_week": "string",
        "firstPartyEntities_month": "string",
        "thirdPartyEntities_hour": "string",
        "thirdPartyEntities_day": "string",
        "thirdPartyEntities_week": "string",
        "thirdPartyEntities_month": "string",
        "emotion_hour": "string",
        "emotion_day": "string",
        "emotion_week": "string",
        "emotion_month": "string",
        "sentiment_hour": "string",
        "sentiment_day": "string",
        "sentiment_week": "string",
        "sentiment_month": "string",
        "questionType_hour": "string",
        "questionType_day": "string",
        "questionType_week": "string",
        "questionType_month": "string",
        "projectId_hour": "string",
        "projectId_day": "string",
        "projectId_week": "string",
        "projectId_month": "string",
        "integrationId_hour": "string",
        "integrationId_day": "string",
        "integrationId_week": "string",
        "integrationId_month": "string",
        "firstMessageTime_hour": "string",
        "firstMessageTime_day": "string",
        "firstMessageTime_week": "string",
        "firstMessageTime_month": "string",
        "lastMessageTime_hour": "string",
        "lastMessageTime_day": "string",
        "lastMessageTime_week": "string",
        "lastMessageTime_month": "string",
        "lastUpdated_hour": "string",
        "lastUpdated_day": "string",
        "lastUpdated_week": "string",
        "lastUpdated_month": "string",
        "hasPositiveFeedback_hour": "string",
        "hasPositiveFeedback_day": "string",
        "hasPositiveFeedback_week": "string",
        "hasPositiveFeedback_month": "string",
        "hasNegativeFeedback_hour": "string",
        "hasNegativeFeedback_day": "string",
        "hasNegativeFeedback_week": "string",
        "hasNegativeFeedback_month": "string",
        "conversationIds_hour": "string",
        "conversationIds_day": "string",
        "conversationIds_week": "string",
        "conversationIds_month": "string",
        "areAIAnnotationsVerified_hour": "string",
        "areAIAnnotationsVerified_day": "string",
        "areAIAnnotationsVerified_week": "string",
        "areAIAnnotationsVerified_month": "string",
        "isInitialQuestionAnswer_hour": "string",
        "isInitialQuestionAnswer_day": "string",
        "isInitialQuestionAnswer_week": "string",
        "isInitialQuestionAnswer_month": "string",
        "sum_id": 0,
        "sum_messageIds": 0,
        "sum_messagesCount": 0,
        "sum_organizationId": 0,
        "sum_question": 0,
        "sum_questionLength": 0,
        "sum_answer": 0,
        "sum_isOnTopic": 0,
        "sum_isClear": 0,
        "sum_isDocumented": 0,
        "sum_isFeatureSupported": 0,
        "sum_isAnswerConfident": 0,
        "sum_gapSummary": 0,
        "sum_subject": 0,
        "sum_category": 0,
        "sum_languages": 0,
        "sum_firstPartyEntities": 0,
        "sum_thirdPartyEntities": 0,
        "sum_emotion": 0,
        "sum_sentiment": 0,
        "sum_questionType": 0,
        "sum_projectId": 0,
        "sum_integrationId": 0,
        "sum_firstMessageTime": 0,
        "sum_lastMessageTime": 0,
        "sum_lastUpdated": 0,
        "sum_hasPositiveFeedback": 0,
        "sum_hasNegativeFeedback": 0,
        "sum_conversationIds": 0,
        "sum_areAIAnnotationsVerified": 0,
        "sum_isInitialQuestionAnswer": 0,
        "count_id": 0,
        "count_messageIds": 0,
        "count_messagesCount": 0,
        "count_organizationId": 0,
        "count_question": 0,
        "count_questionLength": 0,
        "count_answer": 0,
        "count_isOnTopic": 0,
        "count_isClear": 0,
        "count_isDocumented": 0,
        "count_isFeatureSupported": 0,
        "count_isAnswerConfident": 0,
        "count_gapSummary": 0,
        "count_subject": 0,
        "count_category": 0,
        "count_languages": 0,
        "count_firstPartyEntities": 0,
        "count_thirdPartyEntities": 0,
        "count_emotion": 0,
        "count_sentiment": 0,
        "count_questionType": 0,
        "count_projectId": 0,
        "count_integrationId": 0,
        "count_firstMessageTime": 0,
        "count_lastMessageTime": 0,
        "count_lastUpdated": 0,
        "count_hasPositiveFeedback": 0,
        "count_hasNegativeFeedback": 0,
        "count_conversationIds": 0,
        "count_areAIAnnotationsVerified": 0,
        "count_isInitialQuestionAnswer": 0,
        "avg_id": 0,
        "avg_messageIds": 0,
        "avg_messagesCount": 0,
        "avg_organizationId": 0,
        "avg_question": 0,
        "avg_questionLength": 0,
        "avg_answer": 0,
        "avg_isOnTopic": 0,
        "avg_isClear": 0,
        "avg_isDocumented": 0,
        "avg_isFeatureSupported": 0,
        "avg_isAnswerConfident": 0,
        "avg_gapSummary": 0,
        "avg_subject": 0,
        "avg_category": 0,
        "avg_languages": 0,
        "avg_firstPartyEntities": 0,
        "avg_thirdPartyEntities": 0,
        "avg_emotion": 0,
        "avg_sentiment": 0,
        "avg_questionType": 0,
        "avg_projectId": 0,
        "avg_integrationId": 0,
        "avg_firstMessageTime": 0,
        "avg_lastMessageTime": 0,
        "avg_lastUpdated": 0,
        "avg_hasPositiveFeedback": 0,
        "avg_hasNegativeFeedback": 0,
        "avg_conversationIds": 0,
        "avg_areAIAnnotationsVerified": 0,
        "avg_isInitialQuestionAnswer": 0,
        "min_id": 0,
        "min_messageIds": 0,
        "min_messagesCount": 0,
        "min_organizationId": 0,
        "min_question": 0,
        "min_questionLength": 0,
        "min_answer": 0,
        "min_isOnTopic": 0,
        "min_isClear": 0,
        "min_isDocumented": 0,
        "min_isFeatureSupported": 0,
        "min_isAnswerConfident": 0,
        "min_gapSummary": 0,
        "min_subject": 0,
        "min_category": 0,
        "min_languages": 0,
        "min_firstPartyEntities": 0,
        "min_thirdPartyEntities": 0,
        "min_emotion": 0,
        "min_sentiment": 0,
        "min_questionType": 0,
        "min_projectId": 0,
        "min_integrationId": 0,
        "min_firstMessageTime": 0,
        "min_lastMessageTime": 0,
        "min_lastUpdated": 0,
        "min_hasPositiveFeedback": 0,
        "min_hasNegativeFeedback": 0,
        "min_conversationIds": 0,
        "min_areAIAnnotationsVerified": 0,
        "min_isInitialQuestionAnswer": 0,
        "max_id": 0,
        "max_messageIds": 0,
        "max_messagesCount": 0,
        "max_organizationId": 0,
        "max_question": 0,
        "max_questionLength": 0,
        "max_answer": 0,
        "max_isOnTopic": 0,
        "max_isClear": 0,
        "max_isDocumented": 0,
        "max_isFeatureSupported": 0,
        "max_isAnswerConfident": 0,
        "max_gapSummary": 0,
        "max_subject": 0,
        "max_category": 0,
        "max_languages": 0,
        "max_firstPartyEntities": 0,
        "max_thirdPartyEntities": 0,
        "max_emotion": 0,
        "max_sentiment": 0,
        "max_questionType": 0,
        "max_projectId": 0,
        "max_integrationId": 0,
        "max_firstMessageTime": 0,
        "max_lastMessageTime": 0,
        "max_lastUpdated": 0,
        "max_hasPositiveFeedback": 0,
        "max_hasNegativeFeedback": 0,
        "max_conversationIds": 0,
        "max_areAIAnnotationsVerified": 0,
        "max_isInitialQuestionAnswer": 0
      }
    ],
    "total": 0,
    "pageSize": 0,
    "count": 0
  }
}