This endpoint can be used to initialize a Custom Metric, link it to a Pelanor property (built-in or Custom Dimension), and populate historical/initial values.
Newly created custom metrics may take up to 3 hours to appear in the platform
A custom metric must be instantiated with at least one data series (temporary limitation)
Use the List Attributes endpoint to get available properties and their IDs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pelanor","colors":{"primary":"#0070eb","light":"#0070eb","dark":"#0070eb"},"logo":{"light":"https://mintcdn.com/pelanor-6a347cfc/pbyqhjH4Ga65EhJ5/logo/light.svg?fit=max\u0026auto=format\u0026n=pbyqhjH4Ga65EhJ5\u0026q=85\u0026s=3d2af6eee3e32cb74de7b9d33ed49e4d","dark":"https://mintcdn.com/pelanor-6a347cfc/pbyqhjH4Ga65EhJ5/logo/dark.svg?fit=max\u0026auto=format\u0026n=pbyqhjH4Ga65EhJ5\u0026q=85\u0026s=fd574d87978e11fd0ae066cfb5d07eee"},"favicon":"/favicon.svg","navbar":{"links":[{"label":"Support","href":"mailto:[email protected]"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.pelanor.io"}},"seo":{"metatags":{"robots":"index, follow"}},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pelanor-6a347cfc","hasAudioNarration":false,"actualSubdomain":"pelanor-6a347cfc","customDomains":["docs.pelanor.io"],"gitSource":{"type":"github","owner":"pelanororg","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae929f02031ef83521692bf:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Documentation","count":30},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Users \u0026 Workspaces","count":8},{"language":"default","tag":"Features","count":8},{"language":"default","tag":"Service Integrations","count":8},{"language":"default","tag":"Custom Metrics","count":5},{"language":"default","tag":"Dimensions \u0026 Segments","count":5},{"language":"default","tag":"Settings \u0026 Administration","count":5},{"language":"default","tag":"Platform Integrations","count":4},{"language":"default","tag":"Custom Invoices","count":3}]},"assistantConfig":{},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-metrics/initialize-custom-metric","slug":"/api-reference/custom-metrics/initialize-custom-metric","pageMetadata":{"title":"Create Custom Metric","openapi":"POST /v2/custom-metrics","description":null,"href":"/api-reference/custom-metrics/initialize-custom-metric"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This endpoint can be used to initialize a Custom Metric, link it to a Pelanor property (built-in or Custom Dimension), and populate historical/initial values.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Newly created custom metrics may take up to 3 hours to appear in the platform`}),`\n`,_jsx(_components.li,{children:`A custom metric must be instantiated with at least one data series (temporary limitation)`}),`\n`]})}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(`a`,{href:`http://localhost:3000/api-reference/schema/get-schema-attributes`,children:`List Attributes`}),` endpoint to get available properties and their IDs.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Custom Metric","openapi":"POST /v2/custom-metrics","description":null,"href":"/api-reference/custom-metrics/initialize-custom-metric"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["CustomMetricsService"],"summary":"Create a custom metric","operationId":"CustomMetricsService_Create","requestBody":"5efa641e-fdb2-4670-a706-fe4c89417154","responses":{"200":"30a5cf6d-3056-4384-9227-7000f2cc1558","default":"d28b80f9-6a9b-4d2f-a5ca-eabefd78d099"},"x-codegen-request-body-name":"body","method":"post","type":"path","servers":["dd7ddd57-662a-4b19-b2e1-12c81d77a6db","4951214d-fcd4-4688-8006-9d60c601cf0a"],"security":["ce19d2a4-3678-4631-9b20-eb1fce28691a"],"path":"/v2/custom-metrics","baseUrlOptions":["https://api.pelanor.io","https://api-eu.pelanor.io"],"title":"Create a custom metric","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"metricName":{"type":"string","uniqueKey":"metricName","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"series":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","uniqueKey":"series.items.[INDEX].values.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"},"value":{"type":"number","format":"double","uniqueKey":"series.items.[INDEX].values.items.[INDEX].value","typeLabel":"number\u003cdouble>"}},"uniqueKey":"series.items.[INDEX].values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"series.items.[INDEX].values","typeLabel":"object[]"},"properties":{"title":"A map from property ID (e.g. \"Region\") to the value","type":"object","additionalProperties":{"type":"string","uniqueKey":"series.items.[INDEX].properties.additionalProperties","typeLabel":"string"},"uniqueKey":"series.items.[INDEX].properties","typeLabel":"A map from property ID (e.g. \"Region\") to the value · object"}},"uniqueKey":"series.items.[INDEX]","typeLabel":"object"},"uniqueKey":"series","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"metricName":"\u003cstring>","description":"\u003cstring>","series":[{"values":[{"timestamp":"2023-11-07T05:31:56Z","value":123}],"properties":{}}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"30a5cf6d-3056-4384-9227-7000f2cc1558":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d28b80f9-6a9b-4d2f-a5ca-eabefd78d099":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","uniqueKey":"details.items.[INDEX].@type","typeLabel":"string"}},"additionalProperties":{"type":"object","uniqueKey":"details.items.[INDEX].additionalProperties","typeLabel":"object"},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring>,\n \"lastName\": \u003cstring>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","details":[{"@type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ce19d2a4-3678-4631-9b20-eb1fce28691a":{"ApiToken":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"dd7ddd57-662a-4b19-b2e1-12c81d77a6db":{"url":"https://api.pelanor.io"},"4951214d-fcd4-4688-8006-9d60c601cf0a":{"url":"https://api-eu.pelanor.io","description":"Production (EU)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiToken","name":"Authorization"}],"title":"ApiToken"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"pelanor-6a347cfc","siteName":"Pelanor","title":"Create Custom Metric - Pelanor","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-17T16:13:02.642Z","originalFileLocation":"api-reference/custom-metrics/initialize-custom-metric.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=\"Pelanor\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Custom Metric - Pelanor\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pelanor\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pelanor-6a347cfc.mintlify.site/_mintlify/api/og/v2?division=Custom+Metrics\u0026amp;title=Create+Custom+Metric\u0026amp;theme=a5456261e1eb752741f077fc\u0026amp;signature=4b1a8c4ef6539d8b8dce3de5f1d83226cfe49863a4b97909e591f8d98ff731be\">\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=\"Create Custom Metric - Pelanor\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pelanor-6a347cfc.mintlify.site/_mintlify/api/og/v2?division=Custom+Metrics\u0026amp;title=Create+Custom+Metric\u0026amp;theme=a5456261e1eb752741f077fc\u0026amp;signature=4b1a8c4ef6539d8b8dce3de5f1d83226cfe49863a4b97909e591f8d98ff731be\">\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/pelanor-6a347cfc/Nz5ij7PSm35nKcVi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pelanor\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070eb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-metrics/initialize-custom-metric.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pelanor.io/#organization\",\"name\":\"Pelanor\",\"url\":\"https://docs.pelanor.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pelanor-6a347cfc/pbyqhjH4Ga65EhJ5/logo/light.svg?fit=max\u0026auto=format\u0026n=pbyqhjH4Ga65EhJ5\u0026q=85\u0026s=3d2af6eee3e32cb74de7b9d33ed49e4d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pelanor.io#website\",\"name\":\"Pelanor\",\"url\":\"https://docs.pelanor.io\",\"publisher\":{\"@id\":\"https://docs.pelanor.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric#webpage\",\"url\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric\",\"name\":\"Create Custom Metric\",\"dateModified\":\"2025-08-17T16:13:02.642Z\",\"isPartOf\":{\"@id\":\"https://docs.pelanor.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Custom Metrics\",\"item\":\"https://docs.pelanor.io/api-reference/custom-metrics/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Custom Metric\",\"item\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric#apireference\",\"headline\":\"Create Custom Metric\",\"name\":\"Create Custom Metric\",\"url\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pelanor.io/api-reference/custom-metrics/initialize-custom-metric#webpage\"},\"dateModified\":\"2025-08-17T16:13:02.642Z\",\"publisher\":{\"@id\":\"https://docs.pelanor.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pelanor.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pelanor\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pelanor","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/getting-started/installing-pelanor"}]},{"tab":"API Documentation","groups":[{"group":"API Overview","pages":[{"title":"Getting Started","icon":"house","href":"/api-reference/getting-started"},{"title":"List Attributes","openapi":"GET /v2/schema/attributes","href":"/api-reference/schema/get-schema-attributes"}]},{"group":"Dimensions \u0026 Segments","pages":[{"title":"Overview \u0026 Examples","icon":"sitemap","href":"/api-reference/dimensions/overview"},{"title":"List Dimensions","openapi":"GET /v2/dimensions","href":"/api-reference/dimensions/get-dimensions"},{"title":"Get Segments","openapi":"GET /v2/dimensions/{dimensionId}/segments","href":"/api-reference/dimensions/get-segments"},{"title":"Create Segment","openapi":"POST /v2/dimensions/{dimensionId}/segments","href":"/api-reference/dimensions/create-segment"},{"title":"Update Segments","openapi":"PUT /v2/dimensions/{dimensionId}/segments/{segmentId}","href":"/api-reference/dimensions/update-segment"}]},{"group":"Reports","pages":[{"title":"Execute Report","openapi":"POST /v2/reports/{reportId}/execute","href":"/api-reference/reports/execute-report"}]},{"group":"Custom Metrics","pages":[{"title":"Overview \u0026 Examples","icon":"sitemap","href":"/api-reference/custom-metrics/overview"},{"title":"List Custom Metrics","openapi":"GET /v2/custom-metrics","description":null,"href":"/api-reference/custom-metrics/get-custom-metrics"},{"title":"Create Custom Metric","openapi":"POST /v2/custom-metrics","href":"/api-reference/custom-metrics/initialize-custom-metric"},{"title":"Update Custom Metric","openapi":"PUT /v2/custom-metrics/{id}","description":null,"href":"/api-reference/custom-metrics/update-metric"},{"title":"Delete Custom Metric","openapi":"DELETE /v2/custom-metrics/{id}","href":"/api-reference/custom-metrics/delete-custom-metric"}]},{"group":"Custom Invoices","pages":[{"title":"Overview \u0026 Examples","icon":"sitemap","href":"/api-reference/custom-invoices/overview"},{"title":"Create Custom Invoice Integration","openapi":"POST /v1/invoices/create","href":"/api-reference/custom-invoices/initialize-integration"},{"title":"Upload Invoice","openapi":"POST /v1/invoices/{id}/upload","href":"/api-reference/custom-invoices/upload-invoice"}]},{"group":"Users \u0026 Workspaces","pages":[{"title":"Get Users","openapi":"GET /v2/users","href":"/api-reference/users/get-users"},{"title":"Invite User","openapi":"POST /v2/users","href":"/api-reference/users/create-user"},{"title":"Delete User","openapi":"DELETE /v2/users/{email}","href":"/api-reference/users/delete-user"},{"title":"List Workspaces","openapi":"GET /v2/workspaces","href":"/api-reference/workspaces/get-workspaces"},{"title":"Create Workspace","openapi":"POST /v2/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"List Workspace Users","openapi":"GET /v2/workspaces/{workspaceId}/users","href":"/api-reference/workspaces/get-workspace-users"},{"title":"Add Workspace Users","openapi":"POST /v2/workspaces/{workspaceId}/users","href":"/api-reference/workspaces/add-workspace-users"},{"title":"Remove Workspace Users","openapi":"DELETE /v2/workspaces/{workspaceId}/users/{email}","href":"/api-reference/workspaces/delete-workspace-users"}]},{"group":"Pricing Rules","pages":[{"title":"List Pricing Rules","openapi":"GET /v2/workspaces/{workspaceId}/pricing-rules","href":"/api-reference/pricing-rules/get-pricing-rules"},{"title":"Create Pricing Rule","openapi":"POST /v2/workspaces/{workspaceId}/pricing-rules","href":"/api-reference/pricing-rules/create-pricing-rule"},{"title":"Delete Pricing Rule","openapi":"DELETE /v2/workspaces/{workspaceId}/pricing-rules/{pricingRuleId}","href":"/api-reference/pricing-rules/delete-pricing-rule"}]},{"group":"Integrations","pages":[{"title":"Get Integrations","openapi":"GET /v2/integrations/collectors","href":"/api-reference/integrations/get-integrations"},{"title":"Create AWS Integration","openapi":"POST /v2/integrations/collectors/aws-cloudformation","href":"/api-reference/integrations/create-aws-integration"}]},{"group":"Webhooks","pages":[{"title":"Anomaly Alert Created","openapi":"webhook anomaly-alert.created","href":"/api-reference/alerts/anomaly-alert-created"}]}]}]},"basePath":"","title":"Create Custom Metric - Pelanor","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}