Optional field to be used only when the kind is tag. It should specify the tag name, which is the same as the key you used in the tags dictionary during the interaction submission.
The values of the selected filter you want to filter on. Note that all the values passed in
the list are considered to be in “or” the one with the other. This means that if the kind is
“topic” and the passed values are “value A”, “value B”, this is equal to topic="value A" or topic="value B".
The conversation id. It uniquely identifies the conversation the interaction belongs to.
This information can be sent via API in order to group interactions, otherwise it will be generated automatically by Nebuly.
Detailed metadata about each RAG item (e.g., source, query, result).
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Documentation","colors":{"primary":"#0a4fff"},"logo":{"light":"https://mintcdn.com/nebulyai/Z4cH-Z3_KpwmkdSB/images/black_logo.svg?fit=max\u0026auto=format\u0026n=Z4cH-Z3_KpwmkdSB\u0026q=85\u0026s=88e0930f5ecc7197a8159a23f17ceb3d","dark":"https://mintcdn.com/nebulyai/Z4cH-Z3_KpwmkdSB/images/white_logo.svg?fit=max\u0026auto=format\u0026n=Z4cH-Z3_KpwmkdSB\u0026q=85\u0026s=3b177bfe210caba95927e81f14efd379"},"favicon":"https://mintcdn.com/nebulyai/h9aKiGKVR2DLe52O/images/fav.png?fit=max\u0026auto=format\u0026n=h9aKiGKVR2DLe52O\u0026q=85\u0026s=1886884b14952466a25e5faa964daefd","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://backend.nebuly.com/event-ingestion"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FEF8F4","dark":"#1b1b1d"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nebulyai","hasAudioNarration":false,"actualSubdomain":"nebulyai","customDomains":["docs.nebuly.com"],"gitSource":{"type":"github","owner":"nebuly-ai","repo":"platform-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb6d1456d3256e25f7df81","collectionId":"0b6c4e7f-12fc-4d9d-9e9d-4ccb9647ccdf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb6d1456d3256e25f7df81"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeb6d1456d3256e25f7df81","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":46},{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"PRODUCTS","count":10},{"language":"default","tag":"Insights API","count":10},{"language":"default","tag":"DATA","count":9},{"language":"default","tag":"UI components","count":9},{"language":"default","tag":"EMPLOYEE AGENTS","count":7},{"language":"default","tag":"REPORTS","count":7},{"language":"default","tag":"PLATFORM","count":7},{"language":"default","tag":"SETUP","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar-content li[data-title]:has(>ul a[class*=\"bg-primary\"])>button{background-color:transparent!important;color:rgb(55 65 81)!important;text-shadow:none!important}.dark #sidebar-content li[data-title]:has(>ul a[class*=\"bg-primary\"])>button{color:rgb(156 163 175)!important}"}],"page":{"pagePath":"embedded-pages/interactions/get-interactions","slug":"/embedded-pages/interactions/get-interactions","pageMetadata":{"title":"Get Interactions","api":"POST https://backend.nebuly.com/api/external/get-interactions","description":null,"href":"/embedded-pages/interactions/get-interactions"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`You need an API key to authenticate. See `,_jsx(_components.a,{href:`/embedded-pages/quickstart`,children:`here`}),` for more information about the API keys.`]}),`\n`,_jsxs(ParamField,{body:`time_range`,type:`object`,required:true,id:`param-time-range`,children:[_jsx(_components.p,{children:`The time range to consider when computing the metrics and analytics to show.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{path:`start`,type:`string`,default:`2024-05-30T09:27:52.420Z`,required:true,id:`param-start`,children:_jsx(_components.p,{children:`The start date for the time-range.`})}),_jsx(ParamField,{path:`end`,type:`string`,default:`2024-05-30T09:27:52.420Z`,required:true,id:`param-end`,children:_jsx(_components.p,{children:`The end date for the time-range.`})})]})]}),`\n`,_jsxs(ParamField,{body:`filters`,type:`object[]`,required:true,id:`param-filters`,children:[_jsx(_components.p,{children:`Filters you can use to get data based only on the interactions you are interested in.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ParamField,{path:`kind`,type:`string`,required:true,id:`param-kind`,children:[_jsx(_components.p,{children:`The filter kind. It can be one of the following values:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`user_intent`}),`\n`,_jsx(_components.li,{children:`negative_user_intent`}),`\n`,_jsx(_components.li,{children:`keyword`}),`\n`,_jsx(_components.li,{children:`user_feedback`}),`\n`,_jsx(_components.li,{children:`tag`}),`\n`,_jsx(_components.li,{children:`type_of_problem`}),`\n`,_jsx(_components.li,{children:`topic`}),`\n`,_jsx(_components.li,{children:`user`}),`\n`,_jsx(_components.li,{children:`user_query`}),`\n`]})]}),_jsx(ParamField,{path:`tag`,type:`string`,id:`param-tag`,children:_jsx(_components.p,{children:`Optional field to be used only when the kind is tag. It should specify the tag name, which is the same as the key you used in the tags dictionary during the interaction submission.`})}),_jsx(ParamField,{path:`values`,type:`string[]`,required:true,id:`param-values`,children:_jsxs(_components.p,{children:[`The values of the selected filter you want to filter on. Note that all the values passed in\nthe list are considered to be in “or” the one with the other. This means that if the kind is\n“topic” and the passed values are “value A”, “value B”, this is equal to `,_jsx(_components.code,{children:`topic=\"value A\" or topic=\"value B\"`}),`.`]})})]})]}),`\n`,_jsx(ParamField,{body:`limit`,type:`integer`,required:true,id:`param-limit`,children:_jsx(_components.p,{children:`Parameter needed for pagination. It indicates the number of rows per page.`})}),`\n`,_jsx(ParamField,{body:`offset`,type:`integer`,required:true,id:`param-offset`,children:_jsx(_components.p,{children:`Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.`})}),`\n`,_jsx(Heading,{level:`1`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`total`,type:`integer`,id:`param-total`,children:_jsx(_components.p,{children:`Needed for pagination. The total number of rows available.`})}),`\n`,_jsx(ResponseField,{name:`offset`,type:`integer`,id:`param-offset-1`,children:_jsx(_components.p,{children:`Needed for pagination. It indicates the offset to be applied to the first rows returned.`})}),`\n`,_jsx(ResponseField,{name:`limit`,type:`integer`,id:`param-limit-1`,children:_jsx(_components.p,{children:`Needed for pagination. It indicates the number of rows per page.`})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object[]`,id:`param-data`,children:[_jsx(_components.p,{children:`The data per interaction.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`The interaction id. It uniquely identifies the interaction and can be used to retrieve further information.`})}),_jsx(ResponseField,{name:`input_text`,type:`string`,id:`param-input-text`,children:_jsx(_components.p,{children:`The input text written by the user.`})}),_jsx(ResponseField,{name:`output_text`,type:`string`,id:`param-output-text`,children:_jsx(_components.p,{children:`The response generated by the assistant.`})}),_jsx(ResponseField,{name:`user_query`,type:`string`,id:`param-user-query`,children:_jsx(_components.p,{children:`A detailed version of the user intent in a single sentence.`})}),_jsx(ResponseField,{name:`end_user`,type:`string`,id:`param-end-user`,children:_jsx(_components.p,{children:`The end user interacting with the LLM.`})}),_jsx(ResponseField,{name:`conversation_id`,type:`string`,id:`param-conversation-id`,children:_jsx(_components.p,{children:`The conversation id. It uniquely identifies the conversation the interaction belongs to.\nThis information can be sent via API in order to group interactions, otherwise it will be generated automatically by Nebuly.`})}),_jsx(ResponseField,{name:`timestamp`,type:`string`,id:`param-timestamp`,children:_jsx(_components.p,{children:`The date when the user input was received by the LLM.`})}),_jsx(ResponseField,{name:`end_timestamp`,type:`string`,id:`param-end-timestamp`,children:_jsx(_components.p,{children:`The date when the assistant response was sent back to the user.`})}),_jsx(ResponseField,{name:`warning_message_v2`,type:`string`,id:`param-warning-message-v2`,children:_jsx(_components.p,{children:`Description of any warnings or issues detected with the LLM response.`})}),_jsx(ResponseField,{name:`negative_intent_message_v2`,type:`string`,id:`param-negative-intent-message-v2`,children:_jsx(_components.p,{children:`If present, it indicates that the user is having a negative experience withing the conversation.`})}),_jsx(ResponseField,{name:`cost`,type:`float`,id:`param-cost`,children:_jsx(_components.p,{children:`Cost of the interaction, in microdollars.`})}),_jsx(ResponseField,{name:`latency`,type:`float`,id:`param-latency`,children:_jsx(_components.p,{children:`Time elapsed between the user input and the assistant response, in seconds.`})}),_jsx(ResponseField,{name:`text_language`,type:`string`,id:`param-text-language`,children:_jsx(_components.p,{children:`Language detected in the user input.`})}),_jsx(ResponseField,{name:`verbosity`,type:`integer`,id:`param-verbosity`,children:_jsx(_components.p,{children:`Number of characters in the output.`})}),_jsx(ResponseField,{name:`pii_removed`,type:`boolean`,id:`param-pii-removed`,children:_jsx(_components.p,{children:`Indicates whether PII was removed from the interaction.`})}),_jsx(ResponseField,{name:`feedback_action_text`,type:`string`,id:`param-feedback-action-text`,children:_jsx(_components.p,{children:`Text content accompanying feedback actions, if any.`})}),_jsx(ResponseField,{name:`feedback_action_rating`,type:`number`,id:`param-feedback-action-rating`,children:_jsx(_components.p,{children:`Numerical rating provided as feedback (e.g., 1–5).`})}),_jsx(ResponseField,{name:`feedback_actions`,type:`string[]`,id:`param-feedback-actions`,children:_jsx(_components.p,{children:`Actions taken or suggested via user feedback (e.g., “thumbs_up”, “thumbs_down”).`})}),_jsx(ResponseField,{name:`sentiment`,type:`string`,id:`param-sentiment`,children:_jsx(_components.p,{children:`Sentiment classification of the interaction, if available (e.g., positive, neutral, negative).`})}),_jsx(ResponseField,{name:`emotions`,type:`string[]`,id:`param-emotions`,children:_jsx(_components.p,{children:`List of detected emotions from the user input.`})}),_jsx(ResponseField,{name:`tags`,type:`object`,id:`param-tags`,children:_jsx(_components.p,{children:`Key-value pairs showing custom tags associated with the interaction.`})}),_jsx(ResponseField,{name:`custom_columns`,type:`object`,id:`param-custom-columns`,children:_jsx(_components.p,{children:`Key-value pairs showing custom columns associated with the interaction defined inside the platform.`})}),_jsx(ResponseField,{name:`custom_aggregates`,type:`object`,id:`param-custom-aggregates`,children:_jsx(_components.p,{children:`Key-value pairs of manually defined aggregates associated with the interaction defined inside the platform.`})}),_jsx(ResponseField,{name:`failure_intelligence`,type:`string`,id:`param-failure-intelligence`,children:_jsx(_components.p,{children:`Failure Intelligence for the interaction. Null when none is set.`})}),_jsx(ResponseField,{name:`aifi_proficiency_score`,type:`number`,id:`param-aifi-proficiency-score`,children:_jsx(_components.p,{children:`AI Proficiency for this interaction, with two digits after the decimal. Null when the interaction has no proficiency score.`})}),_jsx(ResponseField,{name:`team`,type:`string`,id:`param-team`,children:_jsx(_components.p,{children:`Team of the user, when available.`})}),_jsx(ResponseField,{name:`market`,type:`string`,id:`param-market`,children:_jsx(_components.p,{children:`Market of the user, when available.`})}),_jsx(ResponseField,{name:`tenure`,type:`string`,id:`param-tenure`,children:_jsx(_components.p,{children:`Tenure of the user, when available.`})}),_jsx(ResponseField,{name:`llm_provider`,type:`string`,id:`param-llm-provider`,children:_jsx(_components.p,{children:`LLM provider for the interaction, when available.`})}),_jsx(ResponseField,{name:`llm_model`,type:`string`,id:`param-llm-model`,children:_jsx(_components.p,{children:`LLM model for the interaction, when available.`})}),_jsx(ResponseField,{name:`risky_behavior`,type:`string`,id:`param-risky-behavior`,children:_jsx(_components.p,{children:`Risky behavior classified for the interaction, when available.`})}),_jsx(ResponseField,{name:`roi_hours_saved`,type:`number`,id:`param-roi-hours-saved`,children:_jsx(_components.p,{children:`Hours saved for this interaction when ROI is enabled. Null when ROI is off.`})}),_jsx(ResponseField,{name:`roi_value_saved`,type:`number`,id:`param-roi-value-saved`,children:_jsx(_components.p,{children:`Value saved for this interaction when ROI is enabled. Null when ROI is off.`})}),_jsx(ResponseField,{name:`rag_details`,type:`object`,id:`param-rag-details`,children:_jsx(_components.p,{children:`Detailed metadata about each RAG item (e.g., source, query, result).`})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Interactions","api":"POST https://backend.nebuly.com/api/external/get-interactions","description":null,"href":"/embedded-pages/interactions/get-interactions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Response","slug":"response","depth":1,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get Interactions","path":"/api/external/get-interactions","servers":[{"url":"https://backend.nebuly.com"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"time_range":[{"type":"object","properties":{"start":[{"type":"string","description":"The start date for the time-range.","required":true}],"end":[{"type":"string","description":"The end date for the time-range.","required":true}]},"description":"The time range to consider when computing the metrics and analytics to show.","required":true}],"filters":[{"type":"array","items":[{"type":"object","properties":{"kind":[{"type":"string","description":"The filter kind. It can be one of the following values: user_intent negative_user_intent keyword user_feedback tag type_of_problem topic user user_query","required":true}],"tag":[{"type":"string","description":"Optional field to be used only when the kind is tag. It should specify the tag name, which is the same as the key you used in the tags dictionary during the interaction submission."}],"values":[{"type":"array","items":[{"type":"string"}],"description":"The values of the selected filter you want to filter on. Note that all the values passed in the list are considered to be in “or” the one with the other. This means that if the kind is “topic” and the passed values are “value A”, “value B”, this is equal to `topic=\"value A\" or topic=\"value B\"` .","required":true}]}}],"description":"Filters you can use to get data based only on the interactions you are interested in.","required":true}],"limit":[{"type":"integer","description":"Parameter needed for pagination. It indicates the number of rows per page.","required":true}],"offset":[{"type":"integer","description":"Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.","required":true}]}}],"examples":{"example":{"value":{"time_range":{"start":"\u003cstring>","end":"\u003cstring>"},"filters":[{"kind":"\u003cstring>","tag":"\u003cstring>","values":["\u003cstring>"]}],"limit":123,"offset":123}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"total":[{"type":"integer","description":"Needed for pagination. The total number of rows available."}],"offset":[{"type":"integer","description":"Needed for pagination. It indicates the offset to be applied to the first rows returned."}],"limit":[{"type":"integer","description":"Needed for pagination. It indicates the number of rows per page."}],"data":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"The interaction id. It uniquely identifies the interaction and can be used to retrieve further information."}],"input_text":[{"type":"string","description":"The input text written by the user."}],"output_text":[{"type":"string","description":"The response generated by the assistant."}],"user_query":[{"type":"string","description":"A detailed version of the user intent in a single sentence."}],"end_user":[{"type":"string","description":"The end user interacting with the LLM."}],"conversation_id":[{"type":"string","description":"The conversation id. It uniquely identifies the conversation the interaction belongs to. This information can be sent via API in order to group interactions, otherwise it will be generated automatically by Nebuly."}],"timestamp":[{"type":"string","description":"The date when the user input was received by the LLM."}],"end_timestamp":[{"type":"string","description":"The date when the assistant response was sent back to the user."}],"warning_message_v2":[{"type":"string","description":"Description of any warnings or issues detected with the LLM response."}],"negative_intent_message_v2":[{"type":"string","description":"If present, it indicates that the user is having a negative experience withing the conversation."}],"cost":[{"type":"number","description":"Cost of the interaction, in microdollars."}],"latency":[{"type":"number","description":"Time elapsed between the user input and the assistant response, in seconds."}],"text_language":[{"type":"string","description":"Language detected in the user input."}],"verbosity":[{"type":"integer","description":"Number of characters in the output."}],"pii_removed":[{"type":"boolean","description":"Indicates whether PII was removed from the interaction."}],"feedback_action_text":[{"type":"string","description":"Text content accompanying feedback actions, if any."}],"feedback_action_rating":[{"type":"number","description":"Numerical rating provided as feedback (e.g., 1–5)."}],"feedback_actions":[{"type":"array","items":[{"type":"string"}],"description":"Actions taken or suggested via user feedback (e.g., “thumbs_up”, “thumbs_down”)."}],"sentiment":[{"type":"string","description":"Sentiment classification of the interaction, if available (e.g., positive, neutral, negative)."}],"emotions":[{"type":"array","items":[{"type":"string"}],"description":"List of detected emotions from the user input."}],"tags":[{"type":"object","properties":{},"description":"Key-value pairs showing custom tags associated with the interaction."}],"custom_columns":[{"type":"object","properties":{},"description":"Key-value pairs showing custom columns associated with the interaction defined inside the platform."}],"custom_aggregates":[{"type":"object","properties":{},"description":"Key-value pairs of manually defined aggregates associated with the interaction defined inside the platform."}],"failure_intelligence":[{"type":"string","description":"Failure Intelligence for the interaction. Null when none is set."}],"aifi_proficiency_score":[{"type":"number","description":"AI Proficiency for this interaction, with two digits after the decimal. Null when the interaction has no proficiency score."}],"team":[{"type":"string","description":"Team of the user, when available."}],"market":[{"type":"string","description":"Market of the user, when available."}],"tenure":[{"type":"string","description":"Tenure of the user, when available."}],"llm_provider":[{"type":"string","description":"LLM provider for the interaction, when available."}],"llm_model":[{"type":"string","description":"LLM model for the interaction, when available."}],"risky_behavior":[{"type":"string","description":"Risky behavior classified for the interaction, when available."}],"roi_hours_saved":[{"type":"number","description":"Hours saved for this interaction when ROI is enabled. Null when ROI is off."}],"roi_value_saved":[{"type":"number","description":"Value saved for this interaction when ROI is enabled. Null when ROI is off."}],"rag_details":[{"type":"object","properties":{},"description":"Detailed metadata about each RAG item (e.g., source, query, result)."}]}}],"description":"The data per interaction."}]}}],"examples":{"example":{"value":{"total":123,"offset":123,"limit":123,"data":[{"id":"\u003cstring>","input_text":"\u003cstring>","output_text":"\u003cstring>","user_query":"\u003cstring>","end_user":"\u003cstring>","conversation_id":"\u003cstring>","timestamp":"\u003cstring>","end_timestamp":"\u003cstring>","warning_message_v2":"\u003cstring>","negative_intent_message_v2":"\u003cstring>","cost":123,"latency":123,"text_language":"\u003cstring>","verbosity":123,"pii_removed":true,"feedback_action_text":"\u003cstring>","feedback_action_rating":123,"feedback_actions":["\u003cstring>"],"sentiment":"\u003cstring>","emotions":["\u003cstring>"],"tags":{},"custom_columns":{},"custom_aggregates":{},"failure_intelligence":"\u003cstring>","aifi_proficiency_score":123,"team":"\u003cstring>","market":"\u003cstring>","tenure":"\u003cstring>","llm_provider":"\u003cstring>","llm_model":"\u003cstring>","risky_behavior":"\u003cstring>","roi_hours_saved":123,"roi_value_saved":123,"rag_details":{}}]}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"nebulyai","siteName":"Documentation","title":"Get Interactions - Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T15:39:32.685Z","originalFileLocation":"embedded-pages/interactions/get-interactions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Interactions - Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nebulyai.mintlify.site/_mintlify/api/og/v2?division=Insights+API\u0026amp;title=Get+Interactions\u0026amp;theme=37f27c4e01a37604eb643b24\u0026amp;signature=365dc9daea622b0ba9ec747aa2d6ff7ae8cab75be1c24000ff5a84eac99e0cd5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Interactions - Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nebulyai.mintlify.site/_mintlify/api/og/v2?division=Insights+API\u0026amp;title=Get+Interactions\u0026amp;theme=37f27c4e01a37604eb643b24\u0026amp;signature=365dc9daea622b0ba9ec747aa2d6ff7ae8cab75be1c24000ff5a84eac99e0cd5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nebulyai/Sm5JTUNJT-7CUVsm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0a4fff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/embedded-pages/interactions/get-interactions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nebuly.com/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.nebuly.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nebulyai/Z4cH-Z3_KpwmkdSB/images/black_logo.svg?fit=max\u0026auto=format\u0026n=Z4cH-Z3_KpwmkdSB\u0026q=85\u0026s=88e0930f5ecc7197a8159a23f17ceb3d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nebuly.com#website\",\"name\":\"Documentation\",\"url\":\"https://docs.nebuly.com\",\"publisher\":{\"@id\":\"https://docs.nebuly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions#webpage\",\"url\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions\",\"name\":\"Get Interactions\",\"dateModified\":\"2026-10-21T15:39:32.685Z\",\"isPartOf\":{\"@id\":\"https://docs.nebuly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Insights API\",\"item\":\"https://docs.nebuly.com/embedded-pages/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Interactions\",\"item\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions#apireference\",\"headline\":\"Get Interactions\",\"name\":\"Get Interactions\",\"url\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interactions#webpage\"},\"dateModified\":\"2026-10-21T15:39:32.685Z\",\"publisher\":{\"@id\":\"https://docs.nebuly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nebuly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":{"name":"lightbulb"},"pages":[{"title":"Documentation","href":"/documentation/what-is-nebuly"}]},{"tab":"API Reference","icon":"code","pages":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/introduction"}]},{"group":"Instrument (Core)","pages":[{"title":"Interaction API","api":"POST https://backend.nebuly.com/event-ingestion/api/v3/events/trace_interaction","href":"/tracking/api-reference/events/post-events-interaction-with-trace-v2"}]},{"group":"Instrument (Optional)","pages":[{"title":"Delete Interactions","api":"POST https://backend.nebuly.com/api/external/projects/delete-interactions","href":"/tracking/api-reference/delete-interactions"},{"title":"Send User Feedback","api":"POST https://backend.nebuly.com/event-ingestion/api/v3/events/feedback","href":"/tracking/api-reference/events/send-user-feedbacks"},{"title":"Send Tags","api":"POST https://backend.nebuly.com/event-ingestion/api/v2/events/tags","href":"/tracking/api-reference/events/send-tags"}]},{"group":"Eligible Users","pages":[{"title":"Overview","href":"/eligible-users/overview"},{"title":"Get Eligible Users","api":"GET https://backend.nebuly.com/api/external/eligible-users","href":"/eligible-users/api-reference/get-eligible-users"},{"title":"Send Eligible Users","api":"POST https://backend.nebuly.com/api/external/eligible-users","href":"/eligible-users/api-reference/send-eligible-users"},{"title":"Update Eligible Users","api":"PUT https://backend.nebuly.com/api/external/eligible-users","href":"/eligible-users/api-reference/update-eligible-users"},{"title":"Delete Eligible Users","api":"DELETE https://backend.nebuly.com/api/external/eligible-users","href":"/eligible-users/api-reference/delete-eligible-users"}]},{"group":"Insights API","pages":[{"title":null,"href":"/embedded-pages/quickstart"},{"title":"Get Interaction Aggregates","api":"POST https://backend.nebuly.com/api/external/get-interaction-aggregates","href":"/embedded-pages/interactions/get-interaction-aggregates"},{"title":"Get Interaction Aggregates V2","api":"POST https://backend.nebuly.com/api/external/get-interaction-aggregates-v2","href":"/embedded-pages/interactions/get-interaction-aggregates-v2"},{"title":"Get Interaction Multi Aggregates","api":"POST https://backend.nebuly.com/api/external/get-interaction-multi-aggregates","description":null,"href":"/embedded-pages/interactions/get-interaction-multi-aggregates"},{"title":"Get Interactions","api":"POST https://backend.nebuly.com/api/external/get-interactions","href":"/embedded-pages/interactions/get-interactions"},{"title":"Get Interactions Time-Series","api":"POST https://backend.nebuly.com/api/external/get-interaction-time-series","description":null,"href":"/embedded-pages/interactions/get-interaction-time-series"},{"title":"Get interaction details V2","api":"GET https://backend.nebuly.com/api/external/export/interactions/detail-v2/{interaction_id}","href":"/embedded-pages/get-interaction-details-v2"},{"title":"Get conversation details","api":"POST https://backend.nebuly.com/api/external/get-conversation-detail","href":"/embedded-pages/get-conversation-details"},{"title":"Create Project","api":"POST https://backend.nebuly.com/api/external/projects/create","href":"/embedded-pages/projects/create-project"},{"title":"Delete Project API Key","api":"POST https://backend.nebuly.com/api/external/projects/delete-api-key","href":"/embedded-pages/projects/delete-api-key"}]},{"group":"Reports API","pages":[{"title":"List Reports","api":"GET https://backend.nebuly.com/api/external/reports/list-reports","href":"/embedded-pages/reports/list-reports"},{"title":"Get Report Data","api":"GET https://backend.nebuly.com/api/external/reports/report-data/{report_id}","href":"/embedded-pages/reports/get-report-data"},{"title":"Get Chart","api":"GET https://backend.nebuly.com/api/external/charts/{chart_id}","href":"/embedded-pages/charts/get-chart"}]},{"group":"Utilities","pages":[{"title":"Get Interaction Deep Link","api":"GET https://backend.nebuly.com/api/external/deeplinks/interaction/{interaction_id}","href":"/embedded-pages/deeplinks/get-interaction-deeplink"},{"title":"Get Conversation Deep Link","api":"GET https://backend.nebuly.com/api/external/deeplinks/conversation/{conversation_id}","href":"/embedded-pages/deeplinks/get-conversation-deeplink"}]}]},{"tab":"Connectors","icon":"puzzle-piece","pages":[{"title":"Connectors","href":"/connectors/langfuse/langfuse"}]},{"tab":"Self-hosting","icon":"server","pages":[{"title":"Self-hosting","href":"/self-hosting/overview"}]},{"tab":"Changelog","icon":{"name":"history"},"pages":[{"title":"Changelog","href":"/changelog/product-changelog"}]},{"tab":"UI components","icon":{"name":"grid"},"pages":[{"title":"UI components","href":"/nebuly-reports/overview"}]}]},"basePath":"","title":"Get Interactions - Documentation","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js"]}