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 variables for which values are required. If omitted, the API computes n_interactions, n_users, cost, and latency_seconds. Any variable you do not request is null.
The supported variables are
The data to be shown on the y axis. Note that the object has as keys the values that correspond to the different group_by values, if a group by has been selected, otherwise a unique key “total” is returned.
Users whose AI Proficiency stayed the same. Request it with aifi_proficiency_stayed.
{"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":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af46447c0e883d574367ccb","clientVersion":"0.0.4111","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":"custom-rbac-roles","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":"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":"editor-metadata","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}],"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-interaction-time-series","slug":"/embedded-pages/interactions/get-interaction-time-series","pageMetadata":{"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"},"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`,_jsxs(ParamField,{body:`variables`,type:`string[]`,id:`param-variables`,children:[_jsxs(_components.p,{children:[`The variables for which values are required. If omitted, the API computes `,_jsx(_components.code,{children:`n_interactions`}),`, `,_jsx(_components.code,{children:`n_users`}),`, `,_jsx(_components.code,{children:`cost`}),`, and `,_jsx(_components.code,{children:`latency_seconds`}),`. Any variable you do not request is null.\nThe supported variables are`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`n_interactions`}),`\n`,_jsx(_components.li,{children:`n_users`}),`\n`,_jsx(_components.li,{children:`user_feedback_v2`}),`\n`,_jsx(_components.li,{children:`cost`}),`\n`,_jsx(_components.li,{children:`latency_seconds`}),`\n`,_jsx(_components.li,{children:`n_intents`}),`\n`,_jsx(_components.li,{children:`retention`}),`\n`,_jsx(_components.li,{children:`aifi_score`}),`\n`,_jsx(_components.li,{children:`aifi_task_clarity_score`}),`\n`,_jsx(_components.li,{children:`aifi_context_provision_score`}),`\n`,_jsx(_components.li,{children:`aifi_output_specification_score`}),`\n`,_jsx(_components.li,{children:`aifi_prompt_length_score`}),`\n`,_jsx(_components.li,{children:`aifi_conversation_efficiency_score`}),`\n`,_jsx(_components.li,{children:`aifi_constraint_specification_score`}),`\n`,_jsx(_components.li,{children:`aifi_proficiency_moved_up`}),`\n`,_jsx(_components.li,{children:`aifi_proficiency_slipped_back`}),`\n`,_jsx(_components.li,{children:`aifi_proficiency_stayed`}),`\n`]})]}),`\n`,_jsxs(ParamField,{body:`granularity`,type:`string`,required:true,id:`param-granularity`,children:[_jsx(_components.p,{children:`The granularity selected for the time-series chart. It can be a value between:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`hour`}),`\n`,_jsx(_components.li,{children:`day`}),`\n`,_jsx(_components.li,{children:`week`}),`\n`,_jsx(_components.li,{children:`month`}),`\n`]})]}),`\n`,_jsx(Heading,{level:`1`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`buckets`,type:`string[]`,id:`param-buckets`,children:_jsx(_components.p,{children:`X axis values accordingly to the selected granularity.`})}),`\n`,_jsxs(ResponseField,{name:`datasets`,type:`object`,id:`param-datasets`,children:[_jsx(_components.p,{children:`The data to be shown on the y axis. Note that the object has as keys the values that correspond to the different group_by values, if a group by has been selected, otherwise a unique key “total” is returned.`}),_jsxs(ResponseField,{name:`\u003cgroup_by_value>`,type:`object[]`,id:`param-group-by-value`,children:[_jsx(_components.p,{children:`Each object in the list corresponds to a different x,y pairs.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`bucket`,type:`string`,id:`param-bucket`,children:_jsx(_components.p,{children:`The x axis value.`})}),_jsx(ResponseField,{name:`n_interactions`,type:`integer`,id:`param-n-interactions`,children:_jsx(_components.p,{children:`The total number of interaction for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_interactions_prev`,type:`integer`,id:`param-n-interactions-prev`,children:_jsx(_components.p,{children:`The total number of interaction for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`n_users`,type:`integer`,id:`param-n-users`,children:_jsx(_components.p,{children:`The total number of distinct users for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_users_prev`,type:`integer`,id:`param-n-users-prev`,children:_jsx(_components.p,{children:`The total number of distinct users for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`n_positive_implicit_user_feedback`,type:`integer`,id:`param-n-positive-implicit-user-feedback`,children:_jsx(_components.p,{children:`The total number of positive implicit feedback for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_positive_implicit_user_feedback_prev`,type:`integer`,id:`param-n-positive-implicit-user-feedback-prev`,children:_jsx(_components.p,{children:`The total number of positive implicit feedback for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`n_negative_implicit_user_feedback`,type:`integer`,id:`param-n-negative-implicit-user-feedback`,children:_jsx(_components.p,{children:`The total number of negative implicit feedback for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_negative_implicit_user_feedback_prev`,type:`integer`,id:`param-n-negative-implicit-user-feedback-prev`,children:_jsx(_components.p,{children:`The total number of negative implicit feedback for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`n_positive_explicit_user_feedback`,type:`integer`,id:`param-n-positive-explicit-user-feedback`,children:_jsx(_components.p,{children:`The total number of positive explicit feedback for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_positive_explicit_user_feedback_prev`,type:`integer`,id:`param-n-positive-explicit-user-feedback-prev`,children:_jsx(_components.p,{children:`The total number of positive explicit feedback for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`n_negative_explicit_user_feedback`,type:`integer`,id:`param-n-negative-explicit-user-feedback`,children:_jsx(_components.p,{children:`The total number of negative explicit feedback for the selected granularity and given x-value.`})}),_jsx(ResponseField,{name:`n_negative_explicit_user_feedback_prev`,type:`integer`,id:`param-n-negative-explicit-user-feedback-prev`,children:_jsx(_components.p,{children:`The total number of negative explicit feedback for the selected granularity, but referring to the previous time-range respect the one considered.`})}),_jsx(ResponseField,{name:`aifi_score`,type:`float`,id:`param-aifi-score`,children:_jsxs(_components.p,{children:[`AI Proficiency for the bucket, with two digits after the decimal. Request it with `,_jsx(_components.code,{children:`aifi_score`}),`. Null when it was not requested.`]})}),_jsx(ResponseField,{name:`aifi_score_prev`,type:`float`,id:`param-aifi-score-prev`,children:_jsx(_components.p,{children:`AI Proficiency for the bucket in the previous period. Null when it was not requested.`})}),_jsx(ResponseField,{name:`aifi_task_clarity_score`,type:`float`,id:`param-aifi-task-clarity-score`,children:_jsxs(_components.p,{children:[`Task clarity component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_task_clarity_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_context_provision_score`,type:`float`,id:`param-aifi-context-provision-score`,children:_jsxs(_components.p,{children:[`Context provision component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_context_provision_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_output_specification_score`,type:`float`,id:`param-aifi-output-specification-score`,children:_jsxs(_components.p,{children:[`Output specification component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_output_specification_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_prompt_length_score`,type:`float`,id:`param-aifi-prompt-length-score`,children:_jsxs(_components.p,{children:[`Prompt length component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_prompt_length_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_conversation_efficiency_score`,type:`float`,id:`param-aifi-conversation-efficiency-score`,children:_jsxs(_components.p,{children:[`Conversation efficiency component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_conversation_efficiency_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_constraint_specification_score`,type:`float`,id:`param-aifi-constraint-specification-score`,children:_jsxs(_components.p,{children:[`Constraint specification component of AI Proficiency. Request it with `,_jsx(_components.code,{children:`aifi_constraint_specification_score`}),`.`]})}),_jsx(ResponseField,{name:`aifi_proficiency_moved_up`,type:`integer`,id:`param-aifi-proficiency-moved-up`,children:_jsxs(_components.p,{children:[`Users whose AI Proficiency moved up. Request it with `,_jsx(_components.code,{children:`aifi_proficiency_moved_up`}),`.`]})}),_jsx(ResponseField,{name:`aifi_proficiency_slipped_back`,type:`integer`,id:`param-aifi-proficiency-slipped-back`,children:_jsxs(_components.p,{children:[`Users whose AI Proficiency slipped back. Request it with `,_jsx(_components.code,{children:`aifi_proficiency_slipped_back`}),`.`]})}),_jsx(ResponseField,{name:`aifi_proficiency_stayed`,type:`integer`,id:`param-aifi-proficiency-stayed`,children:_jsxs(_components.p,{children:[`Users whose AI Proficiency stayed the same. Request it with `,_jsx(_components.code,{children:`aifi_proficiency_stayed`}),`.`]})})]})]})]})]})}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 Time-Series","api":"POST https://backend.nebuly.com/api/external/get-interaction-time-series","description":null,"href":"/embedded-pages/interactions/get-interaction-time-series"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Response","slug":"response","depth":1,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get Interactions Time-Series","path":"/api/external/get-interaction-time-series","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}],"variables":[{"type":"array","items":[{"type":"string"}],"description":"The variables for which values are required. If omitted, the API computes `n_interactions` , `n_users` , `cost` , and `latency_seconds` . Any variable you do not request is null. The supported variables are n_interactions n_users user_feedback_v2 cost latency_seconds n_intents retention aifi_score aifi_task_clarity_score aifi_context_provision_score aifi_output_specification_score aifi_prompt_length_score aifi_conversation_efficiency_score aifi_constraint_specification_score aifi_proficiency_moved_up aifi_proficiency_slipped_back aifi_proficiency_stayed"}],"granularity":[{"type":"string","description":"The granularity selected for the time-series chart. It can be a value between: hour day week month","required":true}]}}],"examples":{"example":{"value":{"time_range":{"start":"\u003cstring>","end":"\u003cstring>"},"filters":[{"kind":"\u003cstring>","tag":"\u003cstring>","values":["\u003cstring>"]}],"variables":["\u003cstring>"],"granularity":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"buckets":[{"type":"array","items":[{"type":"string"}],"description":"X axis values accordingly to the selected granularity."}],"datasets":[{"type":"object","properties":{"\u003cgroup_by_value>":[{"type":"array","items":[{"type":"object","properties":{"bucket":[{"type":"string","description":"The x axis value."}],"n_interactions":[{"type":"integer","description":"The total number of interaction for the selected granularity and given x-value."}],"n_interactions_prev":[{"type":"integer","description":"The total number of interaction for the selected granularity, but referring to the previous time-range respect the one considered."}],"n_users":[{"type":"integer","description":"The total number of distinct users for the selected granularity and given x-value."}],"n_users_prev":[{"type":"integer","description":"The total number of distinct users for the selected granularity, but referring to the previous time-range respect the one considered."}],"n_positive_implicit_user_feedback":[{"type":"integer","description":"The total number of positive implicit feedback for the selected granularity and given x-value."}],"n_positive_implicit_user_feedback_prev":[{"type":"integer","description":"The total number of positive implicit feedback for the selected granularity, but referring to the previous time-range respect the one considered."}],"n_negative_implicit_user_feedback":[{"type":"integer","description":"The total number of negative implicit feedback for the selected granularity and given x-value."}],"n_negative_implicit_user_feedback_prev":[{"type":"integer","description":"The total number of negative implicit feedback for the selected granularity, but referring to the previous time-range respect the one considered."}],"n_positive_explicit_user_feedback":[{"type":"integer","description":"The total number of positive explicit feedback for the selected granularity and given x-value."}],"n_positive_explicit_user_feedback_prev":[{"type":"integer","description":"The total number of positive explicit feedback for the selected granularity, but referring to the previous time-range respect the one considered."}],"n_negative_explicit_user_feedback":[{"type":"integer","description":"The total number of negative explicit feedback for the selected granularity and given x-value."}],"n_negative_explicit_user_feedback_prev":[{"type":"integer","description":"The total number of negative explicit feedback for the selected granularity, but referring to the previous time-range respect the one considered."}],"aifi_score":[{"type":"number","description":"AI Proficiency for the bucket, with two digits after the decimal. Request it with `aifi_score` . Null when it was not requested."}],"aifi_score_prev":[{"type":"number","description":"AI Proficiency for the bucket in the previous period. Null when it was not requested."}],"aifi_task_clarity_score":[{"type":"number","description":"Task clarity component of AI Proficiency. Request it with `aifi_task_clarity_score` ."}],"aifi_context_provision_score":[{"type":"number","description":"Context provision component of AI Proficiency. Request it with `aifi_context_provision_score` ."}],"aifi_output_specification_score":[{"type":"number","description":"Output specification component of AI Proficiency. Request it with `aifi_output_specification_score` ."}],"aifi_prompt_length_score":[{"type":"number","description":"Prompt length component of AI Proficiency. Request it with `aifi_prompt_length_score` ."}],"aifi_conversation_efficiency_score":[{"type":"number","description":"Conversation efficiency component of AI Proficiency. Request it with `aifi_conversation_efficiency_score` ."}],"aifi_constraint_specification_score":[{"type":"number","description":"Constraint specification component of AI Proficiency. Request it with `aifi_constraint_specification_score` ."}],"aifi_proficiency_moved_up":[{"type":"integer","description":"Users whose AI Proficiency moved up. Request it with `aifi_proficiency_moved_up` ."}],"aifi_proficiency_slipped_back":[{"type":"integer","description":"Users whose AI Proficiency slipped back. Request it with `aifi_proficiency_slipped_back` ."}],"aifi_proficiency_stayed":[{"type":"integer","description":"Users whose AI Proficiency stayed the same. Request it with `aifi_proficiency_stayed` ."}]}}],"description":"Each object in the list corresponds to a different x,y pairs."}]},"description":"The data to be shown on the y axis. Note that the object has as keys the values that correspond to the different group_by values, if a group by has been selected, otherwise a unique key “total” is returned."}]}}],"examples":{"example":{"value":{"buckets":["\u003cstring>"],"datasets":{"\u003cgroup_by_value>":[{"bucket":"\u003cstring>","n_interactions":123,"n_interactions_prev":123,"n_users":123,"n_users_prev":123,"n_positive_implicit_user_feedback":123,"n_positive_implicit_user_feedback_prev":123,"n_negative_implicit_user_feedback":123,"n_negative_implicit_user_feedback_prev":123,"n_positive_explicit_user_feedback":123,"n_positive_explicit_user_feedback_prev":123,"n_negative_explicit_user_feedback":123,"n_negative_explicit_user_feedback_prev":123,"aifi_score":123,"aifi_score_prev":123,"aifi_task_clarity_score":123,"aifi_context_provision_score":123,"aifi_output_specification_score":123,"aifi_prompt_length_score":123,"aifi_conversation_efficiency_score":123,"aifi_constraint_specification_score":123,"aifi_proficiency_moved_up":123,"aifi_proficiency_slipped_back":123,"aifi_proficiency_stayed":123}]}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"nebulyai","siteName":"Documentation","title":"Get Interactions Time-Series - Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T15:39:32.686Z","originalFileLocation":"embedded-pages/interactions/get-interaction-time-series.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 Time-Series - 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-interaction-time-series\">\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+Time-Series\u0026amp;theme=39fd014a340346dc9babac9f\u0026amp;signature=24892e00834adbff2ce2797ec90f08f3c33773f48d717d9e3631211db5ccaeda\">\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 Time-Series - Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nebulyai.mintlify.site/_mintlify/api/og/v2?division=Insights+API\u0026amp;title=Get+Interactions+Time-Series\u0026amp;theme=39fd014a340346dc9babac9f\u0026amp;signature=24892e00834adbff2ce2797ec90f08f3c33773f48d717d9e3631211db5ccaeda\">\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-interaction-time-series\">\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-interaction-time-series.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-interaction-time-series#webpage\",\"url\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series\",\"name\":\"Get Interactions Time-Series\",\"dateModified\":\"2026-10-21T15:39:32.686Z\",\"isPartOf\":{\"@id\":\"https://docs.nebuly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Insights API\",\"item\":\"https://docs.nebuly.com/embedded-pages/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Interactions Time-Series\",\"item\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series#apireference\",\"headline\":\"Get Interactions Time-Series\",\"name\":\"Get Interactions Time-Series\",\"url\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nebuly.com/embedded-pages/interactions/get-interaction-time-series#webpage\"},\"dateModified\":\"2026-10-21T15:39:32.686Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/embedded-pages/interactions/get-interaction-time-series.md","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","href":"/embedded-pages/interactions/get-interaction-multi-aggregates"},{"title":"Get Interactions","api":"POST https://backend.nebuly.com/api/external/get-interactions","description":null,"href":"/embedded-pages/interactions/get-interactions"},{"title":"Get Interactions Time-Series","api":"POST https://backend.nebuly.com/api/external/get-interaction-time-series","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}","description":null,"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 Time-Series - Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js"]}