{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aura API","description":"REST and GraphQL APIs for partner integrations","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#6D28D9"},"favicon":"https://mintcdn.com/aura-84f04a78/ysSUChuBcy4CPcDn/favicon.png?fit=max\u0026auto=format\u0026n=ysSUChuBcy4CPcDn\u0026q=85\u0026s=8ccf8e6924b6cad812298ed2ea32fc94","navbar":{"links":[{"href":"https://app.aura-app.ai","label":"Aura"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aura-84f04a78","hasAudioNarration":false,"actualSubdomain":"aura-84f04a78","customDomains":["docs.api.aura-app.ai"],"gitSource":{"type":"github","owner":"aura-app-ai","repo":"aura","deployBranch":"main","contentDirectory":"apps/api-docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","collectionId":"088fa338-5010-438a-996a-01f21e70c0d1","liveDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adc197a3dbc661bca0dff4d","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"GraphQL API","count":114},{"language":"default","tag":"Types","count":86},{"language":"default","tag":"REST API","count":55},{"language":"default","tag":"API reference","count":49},{"language":"default","tag":"Queries","count":19},{"language":"default","tag":"Calls","count":10},{"language":"default","tag":"Mutations","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Leads","count":7},{"language":"default","tag":"Analytics","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"openapi/v1/funnel/events/post","slug":"/openapi/v1/funnel/events/post","pageMetadata":{"title":"Ingest an external funnel event","description":null,"openapi":"openapi.json POST /v1/funnel/events","href":"/openapi/v1/funnel/events/post"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Ingest an external funnel event","description":null,"openapi":"openapi.json POST /v1/funnel/events","href":"/openapi/v1/funnel/events/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/aura-84f04a78/a23b3099adac29d9/search-focus.js"],"openApiReferenceData":{"operation":{"requestBody":"b55160ab-8d6b-432f-98f5-e8926316b52a","responses":{"202":"d2b1827a-adbc-4847-b17d-3dce3205dfd1","400":"95fb4da4-cf23-4ae5-a06d-ae8f3e44bc7e","401":"6f4c47d6-31ec-4805-9ac8-5d19619978e0","402":"cc733f00-4d3a-437e-ada4-778198c8977a","403":"c16c3f31-af58-4374-9823-26cbeadbe9c0","408":"38d326b2-4612-4fa5-b31e-d6a5194e5d27","413":"ca7d3598-0e7b-4411-903b-2f8a5acf15f1","429":"f29d62c0-5cbb-4695-b002-47c02716c50c","500":"9133b99b-6d18-4367-8d26-b33e636b381e"},"security":["55c2508e-01a1-4546-a079-3e19fa3c62f4"],"summary":"Ingest an external funnel event","tags":["Funnel Events"],"method":"post","type":"path","servers":["5221a7e1-3d3d-4c69-849e-b4d57dd9af35","171a8e50-7771-4b7a-972e-29a2e587af64","5e31f02a-c4b3-4824-b16e-80268ce26955"],"path":"/v1/funnel/events","baseUrlOptions":["https://api.aura-app.ai","https://staging-api.aura-app.ai","http://localhost:3001"],"title":"Ingest an external funnel event","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"consentState":{"enum":["granted","not_required"],"type":"string","isRequired":true,"uniqueKey":"consentState","typeLabel":"enum\u003cstring>"},"deviceClass":{"enum":["mobile","tablet","desktop","unknown"],"type":"string","isRequired":true,"uniqueKey":"deviceClass","typeLabel":"enum\u003cstring>"},"eventId":{"maxLength":128,"minLength":8,"type":"string","isRequired":true,"uniqueKey":"eventId","typeLabel":"string"},"eventType":{"enum":["page_view","engaged_visit","cta_click","form_start","booking_open","lead_submission","booking_completion","purchase_completion","purchase_refund"],"type":"string","isRequired":true,"uniqueKey":"eventType","typeLabel":"enum\u003cstring>"},"funnelId":{"maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"funnelId","typeLabel":"string"},"occurredAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"occurredAt","typeLabel":"string\u003cdate-time>"},"pagePath":{"maxLength":2000,"type":"string","isRequired":true,"uniqueKey":"pagePath","typeLabel":"string"},"sourceDomain":{"maxLength":253,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sourceDomain","typeLabel":"string"},"version":{"oneOf":[{"type":"number","enum":[1],"isRequired":true,"uniqueKey":"version.oneOf.0","typeLabel":"enum\u003cnumber>"},{"type":"number","enum":[2],"isRequired":true,"uniqueKey":"version.oneOf.1","typeLabel":"enum\u003cnumber>"}],"isRequired":true,"uniqueKey":"version","typeLabel":"enum\u003cnumber>"},"visitorId":{"maxLength":128,"minLength":8,"type":"string","isRequired":true,"uniqueKey":"visitorId","typeLabel":"string"},"advertising":{"additionalProperties":false,"properties":{"eventId":{"maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"advertising.eventId","typeLabel":"string"},"eventSourceUrl":{"format":"uri","maxLength":2000,"type":"string","isRequired":true,"uniqueKey":"advertising.eventSourceUrl","typeLabel":"string\u003curi>"},"eventTime":{"exclusiveMinimum":true,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"advertising.eventTime","typeLabel":"integer"},"fbp":{"oneOf":[{"maxLength":500,"type":"string","uniqueKey":"advertising.fbp.oneOf.0","typeLabel":"string"},{"maxLength":500,"type":"null","uniqueKey":"advertising.fbp.oneOf.1","typeLabel":"null"}],"uniqueKey":"advertising.fbp","typeLabel":"string | null"}},"required":["eventId","eventTime","eventSourceUrl"],"type":"object","uniqueKey":"advertising","typeLabel":"object"},"attribution":{"additionalProperties":false,"properties":{"fbclid":{"oneOf":[{"maxLength":500,"type":"string","uniqueKey":"attribution.fbclid.oneOf.0","typeLabel":"string"},{"maxLength":500,"type":"null","uniqueKey":"attribution.fbclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.fbclid","typeLabel":"string | null"},"gclid":{"oneOf":[{"maxLength":500,"type":"string","uniqueKey":"attribution.gclid.oneOf.0","typeLabel":"string"},{"maxLength":500,"type":"null","uniqueKey":"attribution.gclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.gclid","typeLabel":"string | null"},"referrer":{"oneOf":[{"format":"uri","maxLength":2000,"type":"string","uniqueKey":"attribution.referrer.oneOf.0","typeLabel":"string\u003curi>"},{"format":"uri","maxLength":2000,"type":"null","uniqueKey":"attribution.referrer.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.referrer","typeLabel":"string\u003curi> | null"},"utmCampaign":{"oneOf":[{"maxLength":300,"type":"string","uniqueKey":"attribution.utmCampaign.oneOf.0","typeLabel":"string"},{"maxLength":300,"type":"null","uniqueKey":"attribution.utmCampaign.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.utmCampaign","typeLabel":"string | null"},"utmContent":{"oneOf":[{"maxLength":300,"type":"string","uniqueKey":"attribution.utmContent.oneOf.0","typeLabel":"string"},{"maxLength":300,"type":"null","uniqueKey":"attribution.utmContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.utmContent","typeLabel":"string | null"},"utmMedium":{"oneOf":[{"maxLength":200,"type":"string","uniqueKey":"attribution.utmMedium.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","uniqueKey":"attribution.utmMedium.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.utmMedium","typeLabel":"string | null"},"utmSource":{"oneOf":[{"maxLength":200,"type":"string","uniqueKey":"attribution.utmSource.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","uniqueKey":"attribution.utmSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.utmSource","typeLabel":"string | null"},"utmTerm":{"oneOf":[{"maxLength":300,"type":"string","uniqueKey":"attribution.utmTerm.oneOf.0","typeLabel":"string"},{"maxLength":300,"type":"null","uniqueKey":"attribution.utmTerm.oneOf.1","typeLabel":"null"}],"uniqueKey":"attribution.utmTerm","typeLabel":"string | null"}},"type":"object","uniqueKey":"attribution","typeLabel":"object"},"gpc":{"type":"boolean","uniqueKey":"gpc","typeLabel":"boolean"},"identity":{"additionalProperties":false,"properties":{"email":{"format":"email","maxLength":320,"type":"string","uniqueKey":"identity.email","typeLabel":"string\u003cemail>"},"firstName":{"maxLength":100,"type":"string","uniqueKey":"identity.firstName","typeLabel":"string"},"lastName":{"maxLength":100,"type":"string","uniqueKey":"identity.lastName","typeLabel":"string"},"phone":{"maxLength":40,"type":"string","uniqueKey":"identity.phone","typeLabel":"string"}},"type":"object","uniqueKey":"identity","typeLabel":"object"},"previousPage":{"oneOf":[{"maxLength":2000,"type":"string","uniqueKey":"previousPage.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","uniqueKey":"previousPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"previousPage","typeLabel":"string | null"},"properties":{"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"properties.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"properties.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"properties.additionalProperties.oneOf.2","typeLabel":"boolean"},{},{"type":"null","uniqueKey":"properties.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"properties.additionalProperties","typeLabel":"string | number | boolean | null"},"type":"object","uniqueKey":"properties","typeLabel":"object"}},"required":["version","eventId","eventType","visitorId","funnelId","sourceDomain","pagePath","occurredAt","consentState","deviceClass"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"eventId":"\u003cstring>","funnelId":"\u003cstring>","occurredAt":"2023-11-07T05:31:56Z","pagePath":"\u003cstring>","sourceDomain":"\u003cstring>","version":1,"visitorId":"\u003cstring>","attribution":{"fbclid":"\u003cstring>","gclid":"\u003cstring>","referrer":"\u003cstring>","utmCampaign":"\u003cstring>","utmContent":"\u003cstring>","utmMedium":"\u003cstring>","utmSource":"\u003cstring>","utmTerm":"\u003cstring>"},"gpc":true,"identity":{"email":"jsmith@example.com","firstName":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"previousPage":"\u003cstring>","properties":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"d2b1827a-adbc-4847-b17d-3dce3205dfd1":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"accepted":{"type":"boolean","isRequired":true,"uniqueKey":"data.accepted","typeLabel":"boolean"},"duplicate":{"type":"boolean","isRequired":true,"uniqueKey":"data.duplicate","typeLabel":"boolean"},"sessionId":{"type":"string","isRequired":true,"uniqueKey":"data.sessionId","typeLabel":"string"}},"required":["accepted","duplicate","sessionId"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"success":{"enum":[true],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"}},"required":["success","data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"accepted":true,"duplicate":true,"sessionId":"\u003cstring>"},"success":true}}},"exampleType":"generated"}},"description":"Event accepted","exampleType":"generated"},"95fb4da4-cf23-4ae5-a06d-ae8f3e44bc7e":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Request validation failed","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"6f4c47d6-31ec-4805-9ac8-5d19619978e0":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Missing or invalid API key","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"cc733f00-4d3a-437e-ada4-778198c8977a":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The organization's subscription is not active","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"c16c3f31-af58-4374-9823-26cbeadbe9c0":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false}}},"exampleType":"generated"}},"description":"Origin or scope rejected","exampleType":"generated"},"38d326b2-4612-4fa5-b31e-d6a5194e5d27":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request exceeded its processing time limit. Check the outcome before retrying a write","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"ca7d3598-0e7b-4411-903b-2f8a5acf15f1":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request body exceeds 256KB","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"f29d62c0-5cbb-4695-b002-47c02716c50c":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Rate limit exceeded. Wait before retrying","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed in the current window","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Window reset as a Unix timestamp","schema":{"type":"string"}},"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"9133b99b-6d18-4367-8d26-b33e636b381e":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unexpected server failure. Include the request identifier when contacting support","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"55c2508e-01a1-4546-a079-3e19fa3c62f4":{"bearerAuth":{"$ref":"b314caf7-eae5-4c6f-b6f7-24ab809c70b0","scopes":[]}}},"servers":{"5221a7e1-3d3d-4c69-849e-b4d57dd9af35":{"description":"Production","url":"https://api.aura-app.ai"},"171a8e50-7771-4b7a-972e-29a2e587af64":{"description":"Staging","url":"https://staging-api.aura-app.ai"},"5e31f02a-c4b3-4824-b16e-80268ce26955":{"description":"Local Development","url":"http://localhost:3001"}}},"originalFileLocation":"openapi.json"},"subdomain":"aura-84f04a78","siteName":"Aura API","title":"Ingest an external funnel event - Aura API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T02:35:49.039Z","originalFileLocation":"openapi/v1/funnel/events/post.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=\"Aura API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Ingest an external funnel event - Aura API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aura API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Funnel\u0026amp;title=Ingest+an+external+funnel+event\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=f2dac3ba987c936f1648314358a39a61ab2db78b268f68ba6010368b815517f0\">\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=\"Ingest an external funnel event - Aura API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Funnel\u0026amp;title=Ingest+an+external+funnel+event\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=f2dac3ba987c936f1648314358a39a61ab2db78b268f68ba6010368b815517f0\">\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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aura API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/openapi/v1/funnel/events/post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.api.aura-app.ai/#organization\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.api.aura-app.ai#website\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post#webpage\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post\",\"name\":\"Ingest an external funnel event\",\"dateModified\":\"2026-10-24T02:35:49.039Z\",\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/leads/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ingest an external funnel event\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post#apireference\",\"headline\":\"Ingest an external funnel event\",\"name\":\"Ingest an external funnel event\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/funnel/events/post#webpage\"},\"dateModified\":\"2026-10-24T02:35:49.039Z\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aura API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aura API","nav":{"global":null,"tabs":[{"tab":"REST API","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":""}]},{"group":"Guides","pages":[{"title":"Making requests","href":"/requests"},{"title":"GraphQL","href":"/graphql"},{"title":"TypeScript client","href":"/sdk"},{"title":"MCP","href":"/mcp-connector"},{"title":"Webhooks","href":"/webhooks"}]},{"group":"API reference","pages":[{"group":"Leads","pages":[{"title":"List leads","openapi":"openapi.json GET /v1/leads","href":"/openapi/v1/leads/get"},{"title":"Archive lead","openapi":"openapi.json DELETE /v1/leads/{id}","href":"/openapi/v1/leads/id/delete"},{"title":"Get lead by ID","openapi":"openapi.json GET /v1/leads/{id}","href":"/openapi/v1/leads/id/get"},{"title":"List lead notes","openapi":"openapi.json GET /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/get"},{"title":"Add lead note","openapi":"openapi.json POST /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/post"},{"title":"Update lead","openapi":"openapi.json PATCH /v1/leads/{id}","href":"/openapi/v1/leads/id/patch"},{"title":"Create lead","openapi":"openapi.json POST /v1/leads","href":"/openapi/v1/leads/post"}]},{"group":"Calls","pages":[{"title":"List calls","openapi":"openapi.json GET /v1/calls","href":"/openapi/v1/calls/get"},{"title":"Get call analysis","openapi":"openapi.json GET /v1/calls/{id}/analysis","href":"/openapi/v1/calls/id/analysis/get"},{"title":"Get call form answers","openapi":"openapi.json GET /v1/calls/{id}/answers","href":"/openapi/v1/calls/id/answers/get"},{"title":"Cancel a booked call","openapi":"openapi.json POST /v1/calls/{id}/cancel","href":"/openapi/v1/calls/id/cancel/post"},{"title":"Get call by ID","openapi":"openapi.json GET /v1/calls/{id}","href":"/openapi/v1/calls/id/get"},{"title":"Set call outcome","openapi":"openapi.json POST /v1/calls/{id}/outcome","href":"/openapi/v1/calls/id/outcome/post"},{"title":"Update call","openapi":"openapi.json PATCH /v1/calls/{id}","href":"/openapi/v1/calls/id/patch"},{"title":"Reassign a booked call to a different closer","openapi":"openapi.json POST /v1/calls/{id}/reassign-closer","href":"/openapi/v1/calls/id/reassign-closer/post"},{"title":"Reschedule a booked call","openapi":"openapi.json POST /v1/calls/{id}/reschedule","href":"/openapi/v1/calls/id/reschedule/post"},{"title":"Create a booking","openapi":"openapi.json POST /v1/calls","href":"/openapi/v1/calls/post"}]},{"group":"Opportunities","pages":[{"title":"List opportunities","openapi":"openapi.json GET /v1/opportunities","href":"/openapi/v1/opportunities/get"},{"title":"Get opportunity by ID","openapi":"openapi.json GET /v1/opportunities/{id}","href":"/openapi/v1/opportunities/id/get"}]},{"group":"Lead qualifications","pages":[{"title":"Qualify a lead (preview)","openapi":"openapi.json POST /v1/lead-qualifications","href":"/openapi/v1/lead-qualifications/post"}]},{"group":"Schedulers","pages":[{"title":"List schedulers","openapi":"openapi.json GET /v1/booking-links","href":"/openapi/v1/booking-links/get"},{"title":"Get bookable time slots for a scheduler","openapi":"openapi.json GET /v1/booking-links/{id}/availability","href":"/openapi/v1/booking-links/id/availability/get"},{"title":"Get scheduler field schema","openapi":"openapi.json GET /v1/booking-links/{id}/fields","href":"/openapi/v1/booking-links/id/fields/get"},{"title":"Get scheduler by ID","openapi":"openapi.json GET /v1/booking-links/{id}","href":"/openapi/v1/booking-links/id/get"}]},{"group":"Team","pages":[{"title":"List team members","openapi":"openapi.json GET /v1/team","href":"/openapi/v1/team/get"},{"title":"Get team member by ID","openapi":"openapi.json GET /v1/team/{id}","href":"/openapi/v1/team/id/get"},{"title":"Get team performance summary","openapi":"openapi.json GET /v1/team/performance","href":"/openapi/v1/team/performance/get"}]},{"group":"Products","pages":[{"title":"List products","openapi":"openapi.json GET /v1/products","href":"/openapi/v1/products/get"},{"title":"Get product by ID","openapi":"openapi.json GET /v1/products/{id}","href":"/openapi/v1/products/id/get"}]},{"group":"Payments","pages":[{"title":"List payments","openapi":"openapi.json GET /v1/payments","href":"/openapi/v1/payments/get"},{"title":"Get payment by ID","openapi":"openapi.json GET /v1/payments/{id}","href":"/openapi/v1/payments/id/get"},{"title":"Update payment","openapi":"openapi.json PATCH /v1/payments/{id}","href":"/openapi/v1/payments/id/patch"},{"title":"Verify payment","openapi":"openapi.json POST /v1/payments/{id}/verify","href":"/openapi/v1/payments/id/verify/post"},{"title":"Record payment","openapi":"openapi.json POST /v1/payments","href":"/openapi/v1/payments/post"}]},{"group":"Analytics","pages":[{"title":"Get per-ad funnel performance","openapi":"openapi.json GET /v1/analytics/ad-performance","href":"/openapi/v1/analytics/ad-performance/get"},{"title":"Get campaign analytics","openapi":"openapi.json GET /v1/analytics/campaigns","href":"/openapi/v1/analytics/campaigns/get"},{"title":"Get dashboard analytics","openapi":"openapi.json GET /v1/analytics/dashboard","href":"/openapi/v1/analytics/dashboard/get"},{"title":"Get lead source analytics","openapi":"openapi.json GET /v1/analytics/lead-sources","href":"/openapi/v1/analytics/lead-sources/get"},{"title":"Get objection analytics","openapi":"openapi.json GET /v1/analytics/objections","href":"/openapi/v1/analytics/objections/get"},{"title":"Get revenue grouped by recorded currency","description":"Choose an existing analytics dimension. Overview and closer use the dashboard date window. Lead source and campaign use lead creation dates. Ad uses booking dates. Each sale is counted once. Missing or conflicting currencies are separate raw amounts. Product filtering applies to overview and closer. Source filtering applies to ad.","openapi":"openapi.json GET /v1/analytics/revenue","href":"/openapi/v1/analytics/revenue/get"}]},{"group":"Funnel","pages":[{"title":"Ingest an external funnel event","openapi":"openapi.json POST /v1/funnel/events","href":"/openapi/v1/funnel/events/post"}]},{"group":"Webhooks","pages":[{"title":"List webhook delivery logs","description":"\nRetrieve a paginated list of webhook delivery attempts for your organization.\n\n**Use Cases:**\n- Monitor webhook delivery health\n- Debug failed deliveries\n- Audit delivery history\n\n**Filtering:**\n- Filter by `subscription_id` to see deliveries for a specific subscription\n\n**Retention:**\n- Delivery logs are retained for 30 days\n ","openapi":"openapi.json GET /v1/webhooks/deliveries","href":"/openapi/v1/webhooks/deliveries/get"},{"title":"List webhook subscriptions","openapi":"openapi.json GET /v1/webhooks","href":"/openapi/v1/webhooks/get"},{"title":"Delete webhook subscription","openapi":"openapi.json DELETE /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/delete"},{"title":"Get webhook subscription by ID","openapi":"openapi.json GET /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/get"},{"title":"Update webhook subscription","openapi":"openapi.json PATCH /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/patch"},{"title":"Rotate webhook secret","openapi":"openapi.json POST /v1/webhooks/{id}/rotate-secret","href":"/openapi/v1/webhooks/id/rotate-secret/post"},{"title":"Create webhook subscription","openapi":"openapi.json POST /v1/webhooks","href":"/openapi/v1/webhooks/post"},{"title":"Test webhook subscription","openapi":"openapi.json POST /v1/webhooks/test","href":"/openapi/v1/webhooks/test/post"}]}]}]},{"tab":"GraphQL API","pages":[{"title":"GraphQL API","href":"/graphql-reference/queries/adPerformance"}]}]},"title":"Ingest an external funnel event - Aura API","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}