Skip to main content

Session content

Overview​

The get_session_content function retrieves the full content of a specific session. Use this endpoint to:

  • Access complete session conversation history
  • Retrieve session metadata and user information
  • Analyze message-level details and AI agent responses

Quick start​

query GetSessionContent($sessionId: String!) {
  get_session_content(args: { session_id: $sessionId }) {
    account_id
    brain_id
    brain_parent_id
    brain_version
    channel
    channel_user_id
    csat_brain
    csat_human_agent
    desk_id
    end_time
    expired_time
    external_user_id
    feedback
    goal_achieved
    insights
    integration_id
    is_contained
    is_covered
    is_test
    messages
    participated_agents
    participated_brains
    participated_collections
    rating
    rule_ids
    session_id
    start_time
    tags
    total_user_messages
    user_email
    user_id
    user_name
    user_sentiment
  }
}

Variables:

{
  "sessionId": "58be4fe7-96af-409b-8ae2-cf6b1c4b51a5"
}

Try it​

Loading GraphQL Playground...

Parameters​

ParameterTypeRequiredDescription
sessionIdStringYesUnique identifier of the session to retrieve
startTimetimestampNoStart time for search window (format: ISO 8601). Adding this improves query performance
endTimetimestampNoEnd time for search window (format: ISO 8601). Adding this improves query performance

Response fields​

Session information​

FieldTypeDescription
session_idStringUnique session identifier
account_iduuidAccount identifier
desk_iduuidAssociated desk ID
integration_iduuidIntegration ID
channelStringCommunication channel (web, facebook, viber, etc.)
start_timetimestampSession start time
end_timetimestampSession end time
expired_timetimestampSession expiration time

AI agent information​

FieldTypeDescription
brain_iduuidAI agent version ID
brain_parent_iduuidAI agent parent ID
brain_versionIntAI agent version number
rule_idsArrayIDs of rules triggered during the session

User information​

FieldTypeDescription
user_idStringUser identifier
user_nameStringUser display name
user_emailStringUser email address
channel_user_idStringChannel-specific user ID
external_user_idStringExternal system user ID

Metrics and quality​

FieldTypeDescription
total_user_messagesIntNumber of user messages
ratingIntUser rating (1-5, null if unrated)
csat_brainIntCustomer satisfaction score for AI agent
csat_human_agentIntCustomer satisfaction score for human agent
user_sentimentIntUser sentiment score
goal_achievedIntGoal achievement status
feedbackStringUser feedback text
insightsjsonbSession insights data

Session properties​

FieldTypeDescription
is_containedBooleanSession handled entirely by AI
is_coveredBooleanSession topics within AI scope
is_testBooleanTest/preview session
tagsArrayAssociated tags
participated_agentsArrayHuman agents involved (null if none)
participated_brainsArrayAI agents involved with details (brain_id, brain_version, brain_parent_id)
participated_collectionsArrayKnowledge base collection IDs used

Messages​

FieldTypeDescription
messagesArrayArray of message objects in the session

Each message object contains:

FieldTypeDescription
timetimestampMessage timestamp
eventStringEvent type (message:received, message:brain_send, session:expired, etc.)
messageObjectMessage content and metadata
agent_iduuidHuman agent ID (if applicable)
brain_iduuidAI agent ID that processed the message
brain_versionIntAI agent version
brain_parent_iduuidAI agent parent ID
request_iduuidRequest identifier
response_timeFloatResponse time in seconds
tagsArrayTags associated with this message
reactionStringUser reaction (thumbs up/down)
rule_idsArrayRules triggered by this message
collection_iduuidKnowledge base collection ID used
collection_sourcesArraySources from knowledge base
collection_request_codeStringKnowledge base request status code
collection_response_codeStringKnowledge base response status code
first_messageBooleanWhether this is the first message
new_brain_sessionBooleanWhether a new AI agent session started
correctionsObjectAny corrections applied
contextObjectContext data

Common use cases​

Get session content by session ID:

{
  "sessionId": "58be4fe7-96af-409b-8ae2-cf6b1c4b51a5"
}

Example response​

{
  "data": {
    "get_session_content": [
      {
        "account_id": "8fb5d9d4-c3f0-4165-a8e9-41655e0fe624",
        "brain_id": "21f45e59-feab-445b-a133-0bb5bf26912f",
        "brain_parent_id": "21f45e59-feab-445b-a133-0bb5bf26912f",
        "brain_version": 0,
        "channel": "web",
        "channel_user_id": null,
        "csat_brain": null,
        "csat_human_agent": null,
        "desk_id": "4168c7cf-1ffc-4f2d-92f9-c5b9d7b2e4ff",
        "end_time": "2024-01-06T07:34:44.286",
        "expired_time": "2024-01-06T08:34:42.268",
        "external_user_id": null,
        "feedback": null,
        "goal_achieved": null,
        "insights": null,
        "integration_id": "92b8a685-9c06-4728-8f0e-446dbd7832d7",
        "is_contained": true,
        "is_covered": true,
        "is_test": false,
        "messages": [
          {
            "time": "2024-01-06T07:34:43.252",
            "event": "message:received",
            "message": {
              "text": "hi"
            },
            "brain_id": "21f45e59-feab-445b-a133-0bb5bf26912f",
            "brain_version": 0,
            "first_message": false,
            "response_time": null
          },
          {
            "time": "2024-01-06T07:34:44.286",
            "event": "message:brain_send",
            "message": {
              "responses": [
                {
                  "text": "Hello! How can I help you?",
                  "type": "text"
                }
              ]
            },
            "brain_id": "21f45e59-feab-445b-a133-0bb5bf26912f",
            "first_message": true,
            "response_time": 0.017233333
          }
        ],
        "participated_agents": null,
        "participated_brains": [
          {
            "brain_id": "21f45e59-feab-445b-a133-0bb5bf26912f",
            "brain_version": 0,
            "brain_parent_id": "21f45e59-feab-445b-a133-0bb5bf26912f"
          }
        ],
        "participated_collections": null,
        "rating": null,
        "rule_ids": ["b9b671b4-e4e1-401a-82d3-38a294f16fdd"],
        "session_id": "cd0c20e2-338d-485f-91ca-cb34766d1ceb",
        "start_time": "2024-01-06T07:34:37.346",
        "tags": ["kg"],
        "total_user_messages": 1,
        "user_email": "test@test.com",
        "user_id": "XpoawAK5aGz2-SDHlo6aT",
        "user_name": "Visitor 41",
        "user_sentiment": null
      }
    ]
  }
}
Last updated on