---
title: "Get Conversations"
method: GET
path: "/v1/analytics/conversations/{application_id}"
tags: ["analytics"]
---

# Get Conversations

`GET /v1/analytics/conversations/{application_id}`

## Request

- Base URL: `https://api.branchly.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.branchly.io/v1/analytics/conversations/{application_id}`
- Auth: HTTP bearer

## Path parameters

- `application_id` string, uuid, required

## Query parameters

- `only_with_interaction` boolean
- `interactions` UIInteractionType[], nullable
- `search_query` string, nullable
- `tool_ids` string[], nullable
- `page` integer
- `limit` integer
- `embed_types` EmbedType[]
- `answer_types` AnswerType[], nullable: Filter by answer types of chat requests. Automatically excludes sessions without chat requests.
- `time_filter` union
  - 'this_month' | 'this_year' | 'last_month' | 'last_30_days' | 'last_6_months' | 'last_12_months'
  - string

## Response `200`

Successful Response

- SessionHistoryAPI
  - `items` SessionAPI[], required
    - `id` string, uuid, required
    - `pk` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form'
    - `start_timestamp` union, required
      - string
      - string, date-time
    - `status` 'active' | 'closed' | 'abandoned', nullable
    - `history` union[]
      - union
        - NavigationRequestItem
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `selected_node_id` string, required
          - `selected_node_title` string, required
          - `selected_node_text` string
          - `selected_node_label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback', required
          - `prior_node_id` string, nullable
          - `prior_node_title` string, nullable
          - `is_last_node` boolean, required
          - `is_contact_node_in_next_nodes` boolean, required
          - `url` string, uri, nullable
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
        - SearchRequestItem
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `query` string, required
          - `search_results` DocumentChunk[], required
            - `chunk_id` string, required
            - `vertex_id` string, required
            - `title` string, required
            - `text` string, required
            - `score` number, required
            - `source` string, nullable
            - `data_source_type` 'website_crawler' | 'file_upload' | 'node_editor' | 'default_node' | 'openAPI' | 'helpspace' | 'custom_website_crawler' | 'webhook' | 'wordpress'
            - `custom_metadata` object, nullable
            - `page_metadata` PageMetadata
              - …
            - `is_cited` boolean, nullable
          - `url` string, uri, nullable
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
        - QARequestItem: Save a request from the /qa/ endpoint in db
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `language` string, nullable
          - `query` string, required
          - `rephrased_query` string, nullable
          - `answer` string, required
          - `tool_calls` ToolCall[]
            - `tool_call_id` string, required
            - `tool_id` string, required
            - `tool_name` string, required
            - `tool_type` 'contact_information' | 'form' | 'knowledge_base' | 'node_lookup' | 'venus_knowledge_graph' | 'send_email' | 'openAPI' | 'weather' | 'web_page_reader' | 'web_search' | 'regiondo' | 'mcp_server' | 'api' | 'buttons' | 'google_maps_link' | 'google_maps_embed' | 'calendly' | 'fallback' | 'further_instructions', required
            - `arguments` string, required
            - `content` string, required
          - `documents` DocumentChunk[], required
            - `chunk_id` string, required
            - `vertex_id` string, required
            - `title` string, required
            - `text` string, required
            - `score` number, required
            - `source` string, nullable
            - `data_source_type` 'website_crawler' | 'file_upload' | 'node_editor' | 'default_node' | 'openAPI' | 'helpspace' | 'custom_website_crawler' | 'webhook' | 'wordpress'
            - `custom_metadata` object, nullable
            - `page_metadata` PageMetadata
              - …
            - `is_cited` boolean, nullable
          - `summary` string, nullable
          - `tags` string[], nullable
          - `answer_type` 'complete' | 'no_knowledge' | 'outside_scope' | 'small_talk' | 'follow_up_question'
          - `sentiment` 'positive' | 'negative' | 'neutral'
          - `url` string, uri, nullable
          - `is_suggested_question` boolean, nullable
          - `use_page_as_context` boolean, nullable
          - `cacheable` boolean, nullable: Indicates if the response is suitable for caching (i.e. it was generated). Can be invalidated.
          - `is_dynamic_query` boolean, nullable: Indicates if the query is dynamic and shouldn't be cached.
          - `is_cached_response` boolean, nullable: Indicates if the response was served from cache.
          - `is_cancelled` boolean, nullable: Indicates if the request was cancelled by the user before completion.
          - `is_fallback` boolean, nullable: Indicates if the response is a fallback message and must not be cached.
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
          - `classification_topic_id` string, uuid, nullable
          - `classification_intent_id` string, uuid, nullable
          - `classification_topic_suggestion_id` string, uuid, nullable
          - `classification_intent_suggestion_id` string, uuid, nullable
        - SARequestItem: Save a request from the /sa/ endpoint in db
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `language` string, nullable
          - `query` string, required
          - `answer` string, required
          - `documents` DocumentChunk[], required
            - `chunk_id` string, required
            - `vertex_id` string, required
            - `title` string, required
            - `text` string, required
            - `score` number, required
            - `source` string, nullable
            - `data_source_type` 'website_crawler' | 'file_upload' | 'node_editor' | 'default_node' | 'openAPI' | 'helpspace' | 'custom_website_crawler' | 'webhook' | 'wordpress'
            - `custom_metadata` object, nullable
            - `page_metadata` PageMetadata
              - …
            - `is_cited` boolean, nullable
          - `summary` string, nullable
          - `tags` string[], nullable
          - `answer_type` 'complete' | 'no_knowledge' | 'outside_scope' | 'small_talk' | 'follow_up_question'
          - `sentiment` 'positive' | 'negative' | 'neutral'
          - `origin` string, nullable
          - `url` string, uri, nullable
          - `is_suggested_question` boolean, nullable
          - `use_page_as_context` boolean, nullable
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
          - `rephrased_query` string, nullable
        - FormSubmissionItem
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `tool_id` string, uuid, required
          - `origin` string, nullable
          - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
          - `data` object, required
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
        - ClickEventItem
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'click_event'
          - `event_type` 'search_result' | 'link' | 'contact' | 'tool' | 'follow_up_navigation' | 'follow_up_question' | 'custom' | 'analytics', required
          - `data` object, required
          - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
        - VoiceRequestItem
          - `id` string, uuid
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `timestamp` string, date-time: Timestamp of the interaction
          - `query` string, required: User query or prompt
          - `answer` string, required: System response
        - FormRequestItem: Save a request from the /form/init endpoint in db
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `language` string, nullable
          - `query` string, required
          - `answer` string, required
          - `tool_calls` ToolCall[]
            - `tool_call_id` string, required
            - `tool_id` string, required
            - `tool_name` string, required
            - `tool_type` 'contact_information' | 'form' | 'knowledge_base' | 'node_lookup' | 'venus_knowledge_graph' | 'send_email' | 'openAPI' | 'weather' | 'web_page_reader' | 'web_search' | 'regiondo' | 'mcp_server' | 'api' | 'buttons' | 'google_maps_link' | 'google_maps_embed' | 'calendly' | 'fallback' | 'further_instructions', required
            - `arguments` string, required
            - `content` string, required
          - `url` string, uri, nullable
          - `is_fallback` boolean, nullable
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
        - FormRoutingRequestItem: Save a request from the /form/route endpoint in db
          - `id` string, uuid
          - `timestamp` string, date-time
          - `type` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
          - `order` integer, required
          - `locale` string, required
          - `language` string, nullable
          - `query` string, required
          - `answer` string, required
          - `tool_calls` ToolCall[]
            - `tool_call_id` string, required
            - `tool_id` string, required
            - `tool_name` string, required
            - `tool_type` 'contact_information' | 'form' | 'knowledge_base' | 'node_lookup' | 'venus_knowledge_graph' | 'send_email' | 'openAPI' | 'weather' | 'web_page_reader' | 'web_search' | 'regiondo' | 'mcp_server' | 'api' | 'buttons' | 'google_maps_link' | 'google_maps_embed' | 'calendly' | 'fallback' | 'further_instructions', required
            - `arguments` string, required
            - `content` string, required
          - `url` string, uri, nullable
          - `is_fallback` boolean, nullable
          - `geography` GeographyInfo: Geography information extracted from request
            - `country` string, nullable: ISO 3166-1 alpha-2 country code
            - `region` string, nullable: Region or state code
          - `device` 'mobile' | 'desktop' | 'tablet' | 'other': Device type extracted from user agent
    - `preview` string, nullable
    - `with_interaction` boolean, nullable
    - `interactions` UIInteractionType[], nullable
    - `tool_calls` string[], nullable
  - `total_items` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/branchly/apis/branchly-io-api.md) · [All operations](https://skmtc.dev/branchly/apis/branchly-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/branchly/apis/branchly-io-api/revisions/9ffb024f8ec8?raw)