List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative’s conversations. Pass eventName to also get that event’s properties, or objectTypeId to get that type’s attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Boom","description":"Boom's public API — REST and MCP over the same capabilities","colors":{"primary":"#3B3B3B","light":"#E5E5E5","dark":"#171717"},"logo":{"light":"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=a014030c9acb0f3d8eee9de1fbe632a7","dark":"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo-dark.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=8ec1c838c16743220fd0e7f46a0be157","href":"/introduction"},"favicon":"https://mintcdn.com/boomai-c1f672dc/4m9zfCL8IkhJn1sI/favicon.svg?fit=max\u0026auto=format\u0026n=4m9zfCL8IkhJn1sI\u0026q=85\u0026s=949c3ecc5e2011cf0a7d4a0e33204c1d","appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:support@useboom.ai","label":"Support"},{"href":"https://app.useboom.ai","label":"Dashboard"}]},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","assistant","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"boomai-c1f672dc","hasAudioNarration":false,"actualSubdomain":"boomai-c1f672dc","customDomains":["docs.useboom.ai"],"gitSource":{"type":"github","owner":"boom-tml","repo":"product-research","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"5be0d5f1-0a0c-4c3c-8fc6-9d0b958374b2","liveDeploymentHistoryId":"6ae91b0b3fd91bd7185157fd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae91b0b3fd91bd7185157fd"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae91b0b3fd91bd7185157fd","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API","count":80},{"language":"default","tag":"Guides","count":35},{"language":"default","tag":"CDP","count":29},{"language":"default","tag":"Initiatives","count":23},{"language":"default","tag":"Journeys","count":22},{"language":"default","tag":"How Boom works","count":18},{"language":"default","tag":"Lead Capture","count":11},{"language":"default","tag":"Tutorials","count":10},{"language":"default","tag":"Segments","count":10},{"language":"default","tag":"Connect your tools","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"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":"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":"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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html{font-size:14px}:root:root{--font-family-headings-custom:ui-sans-serif, system-ui, sans-serif;--font-family-body-custom:ui-sans-serif, system-ui, sans-serif}#page-title{font-weight:400!important;letter-spacing:-.025em!important}#content-area .prose h2{font-weight:400;letter-spacing:-.015em}#content-area .prose h3{font-weight:500;letter-spacing:-.008em}body{background-color:oklch(.97 0 0)}.dark body{background-color:oklch(.18 0 0)}#content-area .text-primary.font-semibold:not(.eyebrow){color:#18181b!important}.dark #content-area .text-primary.font-semibold:not(.eyebrow){color:#f4f4f5!important}#pagination{background-color:transparent!important;border:0!important;border-top:1px solid rgba(17,17,26,.08)!important;border-radius:0!important;padding:1.25rem 0 0!important}.dark #pagination{border-top-color:rgba(255,255,255,.08)!important}#footer a[href*=mintlify],#pagination a .flex-col.items-end,#pagination a .w-px{display:none!important}#pagination a.w-full>div{justify-content:flex-end!important}@media (min-width:1024px){#sidebar-content{width:18rem!important}#body-content{padding-left:18rem!important}}#sidebar-content a[aria-current=page]{background-color:oklch(.955 .004 80);border-radius:.5rem}.dark #sidebar-content a[aria-current=page]{background-color:rgba(255,255,255,.06)}#sidebar-content [class*=group i]:not(a):not(:has(a)),#sidebar-content h5,#sidebar-content li>div:first-child>p:first-child:not(:has(a)){font-size:.9rem!important;font-weight:600!important;letter-spacing:normal!important;text-transform:none!important}.boom-home{--bh-ink:oklch(0.145 0 0);--bh-muted:oklch(0.556 0 0);--bh-hero:oklch(0.984 0.003 85);--bh-card:oklch(0.984 0.003 85);--bh-line:rgba(0, 0, 0, 0.07);--bh-grain:url(\"data:image/svg+xml;utf8,\u003csvg xmlns='http://www.w3.org/2000/svg' width='220' height='220'>\u003cfilter id='n'>\u003cfeTurbulence type='fractalNoise' baseFrequency='0.72' numOctaves='3' stitchTiles='stitch'/>\u003cfeColorMatrix values='0 0 0 0 0.5 0 0 0 0 0.5 0 0 0 0 0.5 0 0 0 1.4 -0.2'/>\u003c/filter>\u003crect width='100%' height='100%' filter='url(%23n)'/>\u003c/svg>\");padding:.5rem 0 1rem;container-type:inline-size}.dark .boom-home{--bh-ink:oklch(0.978 0.001 286);--bh-muted:oklch(0.78 0.016 286);--bh-hero:rgba(255, 255, 255, 0.03);--bh-card:rgba(255, 255, 255, 0.03);--bh-line:rgba(255, 255, 255, 0.08)}.boom-home a,.boom-home a:focus,.boom-home a:hover{text-decoration:none;border:0}.boom-home span{display:block}.boom-home .bh-hero{position:relative;overflow:hidden;isolation:isolate;border-radius:24px;border:1px solid var(--bh-line);background:var(--bh-hero);padding:clamp(2.5rem,7vw,4.5rem) clamp(1.5rem,5vw,3.5rem);margin-bottom:1rem}.boom-home .bh-eyebrow{display:inline-block;font-size:.93rem;color:var(--bh-muted);border:1px solid var(--bh-line);border-radius:999px;padding:.3rem .8rem;background:rgba(255,255,255,.8)}.dark .boom-home .bh-eyebrow{background:rgba(255,255,255,.04)}.boom-home .bh-title{margin:1.4rem 0 0;max-width:14ch;font-weight:400;font-size:clamp(2.6rem,6.5vw,4.2rem);line-height:1.04;letter-spacing:-.025em;color:var(--bh-ink);opacity:.85;text-wrap:balance}.boom-home .bh-sub{margin:1.25rem 0 0;max-width:34rem;color:var(--bh-muted);font-size:1.15rem;line-height:1.6;text-wrap:pretty}.boom-home .bh-arcs{position:absolute;z-index:-1;right:-17rem;top:50%;width:34rem;height:34rem;transform:translateY(-50%);color:var(--bh-ink);opacity:.16;pointer-events:none}.boom-home .bh-arcs svg{width:100%;height:100%}@media (max-width:640px){.boom-home .bh-arcs{display:none}}.boom-home .bh-grid{display:grid;grid-template-columns:repeat(3,minmax(0,1fr));gap:.75rem}@container (max-width: 820px){.boom-home .bh-grid{grid-template-columns:repeat(2,minmax(0,1fr))}}@container (max-width: 520px){.boom-home .bh-grid{grid-template-columns:1fr}}.boom-home .bh-tile{position:relative;overflow:hidden;isolation:isolate;height:17rem;border-radius:24px;border:1px solid var(--bh-line);background:var(--bh-card)}.boom-home .bh-tile:focus-visible{outline:2px solid var(--bh-ink);outline-offset:3px}.boom-home .bh-paint{position:absolute;inset:0;z-index:-1;opacity:0;background:var(--bh-paint);transition:opacity .5s ease-out}.boom-home .bh-paint::after{content:\"\";position:absolute;inset:0;mix-blend-mode:overlay;opacity:.7;background-image:var(--bh-grain)}.boom-home .bh-tile:focus-visible .bh-paint,.boom-home .bh-tile:hover .bh-paint{opacity:1}.boom-home .bh-tile:nth-child(1){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.84 0.07 315) 0%, transparent 60%), linear-gradient(180deg, oklch(0.62 0.13 305), oklch(0.42 0.12 295))}.boom-home .bh-tile:nth-child(2){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.9 0.09 85) 0%, transparent 60%), linear-gradient(180deg, oklch(0.72 0.13 55), oklch(0.5 0.14 22))}.boom-home .bh-tile:nth-child(3){--bh-paint:radial-gradient(85% 60% at 10% 0%, oklch(0.88 0.06 30) 0%, transparent 60%), linear-gradient(180deg, oklch(0.66 0.13 18), oklch(0.46 0.13 0))}.boom-home .bh-tile:nth-child(4){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.88 0.06 220) 0%, transparent 60%), linear-gradient(180deg, oklch(0.66 0.11 240), oklch(0.4 0.1 258))}.boom-home .bh-tile:nth-child(5){--bh-paint:radial-gradient(85% 60% at 10% 0%, oklch(0.88 0.08 150) 0%, transparent 60%), linear-gradient(180deg, oklch(0.6 0.09 180), oklch(0.4 0.07 215))}.boom-home .bh-tile:nth-child(6){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.8 0.09 295) 0%, transparent 60%), linear-gradient(180deg, oklch(0.55 0.15 280), oklch(0.33 0.11 268))}.boom-home .bh-art{position:absolute;inset:0 0 5.25rem;display:grid;place-items:center;padding:1.25rem 2rem 0;color:var(--bh-ink);opacity:.85;transition:color .5s ease,opacity .5s ease}.boom-home .bh-art svg{width:100%;max-width:230px;height:140px;overflow:visible}.boom-home .bh-text{position:absolute;inset:auto 0 0;height:5.25rem;padding:0 1.5rem;text-align:center}.boom-home .bh-h{font-size:1.15rem;font-weight:500;letter-spacing:-.008em;color:var(--bh-ink);transition:color .5s ease}.boom-home .bh-p{margin:.3rem auto 0;font-size:.95rem;font-weight:400;line-height:1.5;color:var(--bh-muted);text-wrap:pretty;transition:color .5s ease}.boom-home .bh-tile:focus-visible .bh-art,.boom-home .bh-tile:hover .bh-art{color:#fff;opacity:1}.boom-home .bh-tile:focus-visible .bh-h,.boom-home .bh-tile:hover .bh-h{color:#fff}.boom-home .bh-tile:focus-visible .bh-p,.boom-home .bh-tile:hover .bh-p{color:rgba(255,255,255,.85)}.boom-home svg .d,.boom-home svg .h{fill:none;stroke:currentColor;stroke-width:.75;vector-effect:non-scaling-stroke}.boom-home svg .d{stroke-dasharray:.5 3;stroke-linecap:round}.boom-home svg .f{fill:currentColor;stroke:none}body:has(.boom-home) #header,body:has(.boom-home) #page-context-menu,body:has(.boom-home) #page-context-menu-button,body:has(.boom-home) #pagination{display:none!important}body:has(.boom-home) #content-area{max-width:72rem!important}#page-context-menu button[aria-haspopup=menu]{height:calc(2rem + 2px)}"}],"page":{"pagePath":"api-reference/initiatives/success-metric-catalog","slug":"/api-reference/initiatives/success-metric-catalog","pageMetadata":{"title":"Success-metric catalog","description":"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass `eventName` to also get that event's properties, or `objectTypeId` to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics/catalog","href":"/api-reference/initiatives/success-metric-catalog","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative’s conversations. Pass \", _jsx(_components.code, {\n children: \"eventName\"\n }), \" to also get that event’s properties, or \", _jsx(_components.code, {\n children: \"objectTypeId\"\n }), \" to get that type’s attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Success-metric catalog","description":"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass `eventName` to also get that event's properties, or `objectTypeId` to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics/catalog","href":"/api-reference/initiatives/success-metric-catalog","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"success_metrics_catalog","summary":"Success-metric catalog","description":"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass `eventName` to also get that event's properties, or `objectTypeId` to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.","tags":["Initiatives"],"parameters":["0931c8ad-4b67-473c-b48b-ebfca2d162eb","04063fb7-c345-4020-aeeb-3d3edf49ab51","f776fb7d-9ef6-4387-8b35-adb17195c06e"],"responses":{"200":"49f9b9bf-4cda-4d68-96b8-6ead5949fe4d","400":"1ca8f022-062e-4946-b76d-698d4fe495f3","401":"a2aa7f14-47b3-4341-ae4d-e1c0fd8c8068","404":"0fa0b6fe-5dea-4987-9c05-029412fe5e42","409":"536ce478-a52e-4116-979d-522f68508026","422":"71c83bd5-e8f4-4fb7-8ab0-8cbc85757121","429":"378d066f-6de0-4833-bee3-c57ad1462bda","500":"97171aac-06dd-4411-ac73-340dee2eb1e2","503":"3a6bba88-62c0-4547-abdb-8eff4700dff5"},"method":"get","type":"path","servers":["ae38953b-be1f-4a27-b0c8-310e1fdb8352","a434e84a-2326-48c1-9798-e68803b52355"],"security":["2a828dae-f463-48c4-9d9e-f5ef7f8f751c"],"path":"/api/v1/initiatives/{id}/success-metrics/catalog","baseUrlOptions":["https://www.useboom.ai","https://dev.useboom.ai"],"title":"Success-metric catalog","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0931c8ad-4b67-473c-b48b-ebfca2d162eb":{"name":"id","in":"path","required":true,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","minLength":1,"description":"The initiative id.","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"04063fb7-c345-4020-aeeb-3d3edf49ab51":{"name":"eventName","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Also return this event's properties, for the value field of a SUM/AVERAGE/MAX metric.","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"f776fb7d-9ef6-4387-8b35-adb17195c06e":{"name":"objectTypeId","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Also return this custom-object type's attributes and its linkage paths to a person.","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"responses":{"49f9b9bf-4cda-4d68-96b8-6ead5949fe4d":{"description":"Success","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].description","typeLabel":"string | null"}},"required":["name","description"],"additionalProperties":false,"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events","typeLabel":"object[]"},"objectTypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"objectTypes.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"objectTypes.items.[INDEX].name","typeLabel":"string"},"displayName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"objectTypes.items.[INDEX].displayName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"objectTypes.items.[INDEX].displayName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"objectTypes.items.[INDEX].displayName","typeLabel":"string | null"}},"required":["id","name","displayName"],"additionalProperties":false,"uniqueKey":"objectTypes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"objectTypes","typeLabel":"object[]"},"variables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"variables.items.[INDEX].id","typeLabel":"string"},"key":{"type":"string","isRequired":true,"uniqueKey":"variables.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"variables.items.[INDEX].label","typeLabel":"string"},"valueKind":{"type":"string","isRequired":true,"uniqueKey":"variables.items.[INDEX].valueKind","typeLabel":"string"}},"required":["id","key","label","valueKind"],"additionalProperties":false,"uniqueKey":"variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"variables","typeLabel":"object[]"},"eventProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX].key","typeLabel":"string"},"inferredType":{"type":"string","isRequired":true,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX].inferredType","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"required":["key","inferredType","description"],"additionalProperties":false,"uniqueKey":"eventProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Null unless `eventName` was given.","isRequired":true,"uniqueKey":"eventProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Null unless `eventName` was given.","isRequired":true,"uniqueKey":"eventProperties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"eventProperties","typeLabel":"object[] | null"},"objectAttributes":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX].key","typeLabel":"string"},"inferredType":{"type":"string","isRequired":true,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX].inferredType","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"required":["key","inferredType","description"],"additionalProperties":false,"uniqueKey":"objectAttributes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Null unless `objectTypeId` was given.","isRequired":true,"uniqueKey":"objectAttributes.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Null unless `objectTypeId` was given.","isRequired":true,"uniqueKey":"objectAttributes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"objectAttributes","typeLabel":"object[] | null"},"linkagePaths":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["PERSON_OBJECT","OBJECT_OBJECT"],"isRequired":true,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"role":{"type":"string","isRequired":true,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path.items.[INDEX].role","typeLabel":"string"},"objectTypeId":{"type":"string","isRequired":true,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path.items.[INDEX].objectTypeId","typeLabel":"string"},"direction":{"type":"string","enum":["PARENT_TO_CHILD","CHILD_TO_PARENT"],"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path.items.[INDEX].direction","typeLabel":"enum\u003cstring>"}},"required":["kind","role","objectTypeId"],"additionalProperties":false,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].path","typeLabel":"object[]"},"label":{"type":"string","isRequired":true,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["path","label"],"additionalProperties":false,"uniqueKey":"linkagePaths.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Null unless `objectTypeId` was given. An empty array means it is linked directly to a person.","isRequired":true,"uniqueKey":"linkagePaths.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Null unless `objectTypeId` was given. An empty array means it is linked directly to a person.","isRequired":true,"uniqueKey":"linkagePaths.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"linkagePaths","typeLabel":"object[] | null"}},"required":["events","objectTypes","variables","eventProperties","objectAttributes","linkagePaths"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"events":[{"name":"\u003cstring>","description":"\u003cstring>"}],"objectTypes":[{"id":"\u003cstring>","name":"\u003cstring>","displayName":"\u003cstring>"}],"variables":[{"id":"\u003cstring>","key":"\u003cstring>","label":"\u003cstring>","valueKind":"\u003cstring>"}],"eventProperties":[{"key":"\u003cstring>","inferredType":"\u003cstring>","description":"\u003cstring>"}],"objectAttributes":[{"key":"\u003cstring>","inferredType":"\u003cstring>","description":"\u003cstring>"}],"linkagePaths":[{"path":[{"kind":"PERSON_OBJECT","role":"\u003cstring>","objectTypeId":"\u003cstring>","direction":"PARENT_TO_CHILD"}],"label":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1ca8f022-062e-4946-b76d-698d4fe495f3":{"description":"Validation failed or the request cannot proceed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a2aa7f14-47b3-4341-ae4d-e1c0fd8c8068":{"description":"Missing, malformed, or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0fa0b6fe-5dea-4987-9c05-029412fe5e42":{"description":"The resource does not exist in this organization.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"536ce478-a52e-4116-979d-522f68508026":{"description":"Conflicts with the current state (duplicates, wrong lifecycle state).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"71c83bd5-e8f4-4fb7-8ab0-8cbc85757121":{"description":"The request is well-formed but semantically invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"378d066f-6de0-4833-bee3-c57ad1462bda":{"description":"Rate limit exceeded — retry after `Retry-After`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"97171aac-06dd-4411-ac73-340dee2eb1e2":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3a6bba88-62c0-4547-abdb-8eff4700dff5":{"description":"Transient error — retry with a narrower request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2a828dae-f463-48c4-9d9e-f5ef7f8f751c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ae38953b-be1f-4a27-b0c8-310e1fdb8352":{"url":"https://www.useboom.ai","description":"Production"},"a434e84a-2326-48c1-9798-e68803b52355":{"url":"https://dev.useboom.ai","description":"Development (sandbox — use a development organization API key)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"boomai-c1f672dc","siteName":"Boom","title":"Success-metric catalog - Boom","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T04:25:56.555Z","originalFileLocation":"api-reference/initiatives/success-metric-catalog.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=\"description\" content=\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative\u0026#x27;s conversations. Pass eventName to also get that event\u0026#x27;s properties, or objectTypeId to get that type\u0026#x27;s attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Boom\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Success-metric catalog - Boom\">\u003cmeta data-mint-head property=\"og:description\" content=\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative\u0026#x27;s conversations. Pass eventName to also get that event\u0026#x27;s properties, or objectTypeId to get that type\u0026#x27;s attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Boom\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://boomai-c1f672dc.mintlify.app/_mintlify/api/og/v2?division=Initiatives\u0026amp;title=Success-metric+catalog\u0026amp;description=List+everything+a+success+metric+can+point+at+on+this+initiative%3A+the+events+this+organization+records%2C+its+custom-object+types%2C+and+the+variables+extracted+fro\u0026amp;theme=83c6d51bda2a99f16cf59c6e\u0026amp;signature=dc0602dc3a73a773cb7b95ef72cc3a3cdc597650edc9f6118e7c5aa34eef566c\">\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=\"Success-metric catalog - Boom\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative\u0026#x27;s conversations. Pass eventName to also get that event\u0026#x27;s properties, or objectTypeId to get that type\u0026#x27;s attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://boomai-c1f672dc.mintlify.app/_mintlify/api/og/v2?division=Initiatives\u0026amp;title=Success-metric+catalog\u0026amp;description=List+everything+a+success+metric+can+point+at+on+this+initiative%3A+the+events+this+organization+records%2C+its+custom-object+types%2C+and+the+variables+extracted+fro\u0026amp;theme=83c6d51bda2a99f16cf59c6e\u0026amp;signature=dc0602dc3a73a773cb7b95ef72cc3a3cdc597650edc9f6118e7c5aa34eef566c\">\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/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Boom\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B3B3B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/initiatives/success-metric-catalog.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useboom.ai/#organization\",\"name\":\"Boom\",\"url\":\"https://docs.useboom.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=a014030c9acb0f3d8eee9de1fbe632a7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useboom.ai#website\",\"name\":\"Boom\",\"url\":\"https://docs.useboom.ai\",\"publisher\":{\"@id\":\"https://docs.useboom.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog#webpage\",\"url\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog\",\"name\":\"Success-metric catalog\",\"description\":\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass eventName to also get that event's properties, or objectTypeId to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\",\"dateModified\":\"2026-10-27T04:25:56.555Z\",\"isPartOf\":{\"@id\":\"https://docs.useboom.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Initiatives\",\"item\":\"https://docs.useboom.ai/api-reference/initiatives/list-initiatives\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Success-metric catalog\",\"item\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog#apireference\",\"headline\":\"Success-metric catalog\",\"name\":\"Success-metric catalog\",\"description\":\"List everything a success metric can point at on this initiative: the events this organization records, its custom-object types, and the variables extracted from this initiative's conversations. Pass eventName to also get that event's properties, or objectTypeId to get that type's attributes and the ways it links to a person. Call this before success_metrics_upsert: an unrecognised event, object type or variable is accepted but never matches anything, so the metric silently reports zero.\",\"url\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/success-metric-catalog#webpage\"},\"dateModified\":\"2026-10-27T04:25:56.555Z\",\"publisher\":{\"@id\":\"https://docs.useboom.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useboom.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Boom\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Boom","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Tutorials","icon":"circle-play","pages":[{"title":"Tutorials","href":"/tutorials/overview"}]},{"tab":"CDP","icon":"layers","pages":[{"title":"CDP","href":"/cdp/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API","sidebarTitle":"Introduction","href":"/api-reference/overview"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Rate limits \u0026 errors","href":"/rate-limits-and-errors"}]},{"group":"Initiatives","icon":"rocket","pages":[{"title":"List initiatives","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives","href":"/api-reference/initiatives/list-initiatives"},{"title":"Get initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}","href":"/api-reference/initiatives/get-initiative"},{"title":"Create initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives","href":"/api-reference/initiatives/create-initiative"},{"title":"Update initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/initiatives/{id}","href":"/api-reference/initiatives/update-initiative"},{"title":"Launch initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/launch","href":"/api-reference/initiatives/launch-initiative"},{"title":"Cancel initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/cancel","href":"/api-reference/initiatives/cancel-initiative"},{"title":"Pause initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/pause","href":"/api-reference/initiatives/pause-initiative"},{"title":"Resume initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/resume","href":"/api-reference/initiatives/resume-initiative"},{"title":"Archive initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/archive","href":"/api-reference/initiatives/archive-initiative"},{"title":"Unarchive initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/unarchive","href":"/api-reference/initiatives/unarchive-initiative"},{"title":"Get templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/templates","href":"/api-reference/initiatives/get-templates"},{"title":"Set template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/templates","href":"/api-reference/initiatives/set-template"},{"title":"Data summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/data/summary","href":"/api-reference/initiatives/data-summary"},{"title":"List success metrics","description":"Read the success metrics configured on an initiative — what counts as a win, and how it is measured. Returns them in the exact shape success_metrics_upsert accepts, so you can read one, edit it and send it back. An initiative with no metric configured returns an empty list. Editing a metric changes what the dashboard reports for past conversations too, because successes are recalculated on every read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics","href":"/api-reference/initiatives/list-success-metrics"},{"title":"Success-metric catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics/catalog","href":"/api-reference/initiatives/success-metric-catalog"},{"title":"Add or replace a success metric","description":"Configure what counts as success for an initiative: a customer-data event, a record on a custom object, or a value extracted from the conversation, measured within 48 hours of the first message. Omit `rootId` to add a metric; pass an existing metric's `rootId` to replace it with a new version. This is not a patch — send the metric's complete configuration, because omitted fields are cleared. Successes are recalculated on every read, so replacing a metric also changes what the dashboard reports for past conversations. Use success_metrics_catalog to find the event, object type or variable to point at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/success-metrics","href":"/api-reference/initiatives/add-or-replace-a-success-metric"},{"title":"Delete a success metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/initiatives/{id}/success-metrics/{rootId}","href":"/api-reference/initiatives/delete-a-success-metric"},{"title":"Add participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/participants","href":"/api-reference/initiatives/add-participants"},{"title":"List participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants","href":"/api-reference/initiatives/list-participants"},{"title":"Get participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants/{participantId}","href":"/api-reference/initiatives/get-participant"},{"title":"Participant messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants/{participantId}/messages","href":"/api-reference/initiatives/participant-messages"},{"title":"List transcripts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/transcripts","href":"/api-reference/initiatives/list-transcripts"},{"title":"Stop participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/participants/{participantId}/stop","href":"/api-reference/initiatives/stop-participant"}]},{"group":"Journeys","icon":"route","pages":[{"title":"List journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys","href":"/api-reference/journeys/list-journeys"},{"title":"Get journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}","href":"/api-reference/journeys/get-journey"},{"title":"Get journey definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}/definition","href":"/api-reference/journeys/get-journey-definition"},{"title":"Node catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/catalog","href":"/api-reference/journeys/node-catalog"},{"title":"Validate journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/validate","href":"/api-reference/journeys/validate-journey"},{"title":"Create draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys","href":"/api-reference/journeys/create-draft"},{"title":"Update draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}","href":"/api-reference/journeys/update-draft"},{"title":"Add node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/nodes","href":"/api-reference/journeys/add-node"},{"title":"Update node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}/nodes/{nodeId}","href":"/api-reference/journeys/update-node"},{"title":"Delete node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/journeys/{journeyId}/nodes/{nodeId}","href":"/api-reference/journeys/delete-node"},{"title":"Connect nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/edges","href":"/api-reference/journeys/connect-nodes"},{"title":"Disconnect nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/journeys/{journeyId}/edges","href":"/api-reference/journeys/disconnect-nodes"},{"title":"Set trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}/trigger","href":"/api-reference/journeys/set-trigger"},{"title":"Fork journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/fork","href":"/api-reference/journeys/fork-journey"},{"title":"Publish journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/publish","href":"/api-reference/journeys/publish-journey"},{"title":"Stop journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/stop","href":"/api-reference/journeys/stop-journey"},{"title":"List message channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/message-channels","href":"/api-reference/journeys/list-message-channels"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/message-templates","href":"/api-reference/journeys/list-message-templates"},{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/email-templates","href":"/api-reference/journeys/list-email-templates"},{"title":"Event catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/event-catalog","href":"/api-reference/journeys/event-catalog"},{"title":"Condition catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/condition-catalog","href":"/api-reference/journeys/condition-catalog"},{"title":"Message variable catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}/message-variables","href":"/api-reference/journeys/message-variable-catalog"}]},{"group":"Segments","icon":"blend","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments","href":"/api-reference/segments/list-segments"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{slug}","href":"/api-reference/segments/get-a-segment"},{"title":"List segment members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{slug}/members","href":"/api-reference/segments/list-segment-members"},{"title":"Get the segment filter catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/catalog","href":"/api-reference/segments/get-the-segment-filter-catalog"},{"title":"Validate a segment filter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/validate","href":"/api-reference/segments/validate-a-segment-filter"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments","href":"/api-reference/segments/create-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/segments/{slug}","href":"/api-reference/segments/update-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/segments/{slug}","href":"/api-reference/segments/delete-a-segment"},{"title":"Preview a segment filter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/preview","href":"/api-reference/segments/preview-a-segment-filter"},{"title":"Evaluate a segment now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/{slug}/evaluate","href":"/api-reference/segments/evaluate-a-segment-now"}]},{"group":"WhatsApp","icon":"https://mintlify.s3.us-west-1.amazonaws.com/boomai-c1f672dc/whatsapp.svg","pages":[{"title":"List numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/whatsapp-numbers","href":"/api-reference/whatsapp-templates/list-numbers"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/templates","href":"/api-reference/whatsapp-templates/create-template"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates/{id}","href":"/api-reference/whatsapp-templates/get-template"},{"title":"Update template tracking","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/templates/{id}/tracking","href":"/api-reference/whatsapp-templates/update-template-tracking"}]},{"group":"Email templates","icon":"envelope","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/email-templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Get email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/email-templates/{templateId}","href":"/api-reference/email-templates/get-email-template"},{"title":"Create email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/email-templates","href":"/api-reference/email-templates/create-email-template"},{"title":"Update email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/email-templates/{templateId}","href":"/api-reference/email-templates/update-email-template"}]},{"group":"Lead Capture","icon":"magnet","pages":[{"title":"List Lead Capture pop-ups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms","href":"/api-reference/lead-capture/list-lead-capture-pop-ups"},{"title":"Get a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms/{formId}","href":"/api-reference/lead-capture/get-a-lead-capture-pop-up"},{"title":"Create a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/forms","href":"/api-reference/lead-capture/create-a-lead-capture-pop-up"},{"title":"Update a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/lead-capture/forms/{formId}","href":"/api-reference/lead-capture/update-a-lead-capture-pop-up"},{"title":"List the leads a pop-up collected","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms/{formId}/leads","href":"/api-reference/lead-capture/list-the-leads-a-pop-up-collected"},{"title":"List embedded forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms","href":"/api-reference/lead-capture/list-embedded-forms"},{"title":"Get an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms/{formId}","href":"/api-reference/lead-capture/get-an-embedded-form"},{"title":"Create an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/embedded-forms","href":"/api-reference/lead-capture/create-an-embedded-form"},{"title":"Update an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/lead-capture/embedded-forms/{formId}","href":"/api-reference/lead-capture/update-an-embedded-form"},{"title":"Publish an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/embedded-forms/{formId}/publish","href":"/api-reference/lead-capture/publish-an-embedded-form"},{"title":"List an embedded form’s responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms/{formId}/responses","href":"/api-reference/lead-capture/list-an-embedded-form’s-responses"}]},{"group":"Message logs","icon":"scroll-text","pages":[{"title":"List message delivery logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/message-logs","href":"/api-reference/message-logs/list-message-delivery-logs"}]}]}]},"basePath":"","title":"Success-metric catalog - Boom","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}