---
title: "Post Metric Types"
method: POST
path: "/insights/metrics/types"
---

# Post Metric Types

`POST /insights/metrics/types`

## Request

- Base URL: `https://app.runconverge.com/api`
- URL: `https://app.runconverge.com/api/insights/metrics/types`
- Auth: none declared

Each metric's data type, as a trends query over them would report it.

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable

## Cookies

- `session_id` string, nullable

## Request body

- MetricTypesRequest
  - `metrics` union[], required
    - union
      - EventMetricInput
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
        - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
        - `type` 'event'
        - `event_name` string, nullable
        - `aggregate` union, required
          - BasicEventMetricAggregate
            - `type` 'events' | 'sessions' | 'profiles' | 'session_conversion_rate' | 'profile_conversion_rate' | 'session_revenue' | 'new_customer_rate' | 'bounce_rate' | 'session_duration' | 'new_visitor_sessions' | 'new_visitor_sessions_rate' | 'cpa' | 'roas' | 'mer' | 'acos' | 'poas' | 'net_profit' | 'gross_margin' | 'contribution_margin' | 'net_margin', required
          - BasicProductMetricAggregate
            - `type` 'product_events' | 'product_sessions' | 'product_profiles' | 'product_session_conversion_rate' | 'product_profile_conversion_rate' | 'product_session_revenue' | 'product_new_customer_rate' | 'product_new_visitor_sessions' | 'product_new_visitor_sessions_rate' | 'product_cpa' | 'product_roas' | 'product_acos' | 'product_poas' | 'product_gross_margin' | 'product_contribution_margin' | 'product_net_profit' | 'product_net_margin' | 'product_quantity', required
          - CustomPropertyEventMetricAggregate
            - `type` 'custom_property'
            - `property_name` union, required
              - …
            - `operation_type` 'count_unique' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'p75' | 'p90' | 'p95' | 'p99', required
          - CustomPropertyProductMetricAggregate
            - `type` 'custom_property_product'
            - `property_name` union, required
              - …
            - `operation_type` 'count_unique' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'p75' | 'p90' | 'p95' | 'p99', required
        - `filters` union[]
          - union
            - EventPropertyFilter
              - …
            - EventSourceFilter
              - …
            - AdPlatformPropertyFilter
              - …
            - AdPlatformSourceFilter
              - …
            - TouchpointFilter
              - …
            - CustomDimensionFilter
              - …
            - AdPropertiesFilter
              - …
        - `attribution` AttributionInput
          - `mode` 'click_time' | 'conversion_time'
          - `model` 'first_touch' | 'first_touch_paid' | 'inv_j_shaped' | 'j_shaped' | 'j_shaped_paid' | 'last_touch' | 'last_touch_paid' | 'linear' | 'participation' | 'time_decay' | 'inv_time_decay' | 'u_shaped' | 'direct_session' | 'inv_j_shaped_paid' | 'top_of_funnel'
          - `window` integer
          - `lookback` integer, nullable
      - AdPlatformMetric
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
        - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
        - `type` 'ad_platform'
        - `column` union, required
          - AdPlatformClickMetric
            - `type` 'clicks'
            - `aggregate_type` 'sum' | 'ctr' | 'cpc', required
          - AdPlatformSpendMetric
            - `type` 'spend'
            - `aggregate_type` 'sum'
          - AdPlatformImpressionsMetric
            - `type` 'impressions'
            - `aggregate_type` 'sum' | 'cpm', required
          - AdPlatformPurchaseConversionsMetric
            - `type` 'purchase_conversions'
            - `aggregate_type` 'sum' | 'cpa' | 'revenue' | 'roas' | 'acos', required
          - AdPlatformCustomConversionsMetric
            - `type` 'custom_conversions'
            - `aggregate_type` 'sum' | 'cpa' | 'revenue' | 'roas' | 'acos', required
            - `conversion_name` string, nullable
            - `channel` string, nullable
          - AdPlatformBuiltinMetric: Hard-coded built-in metrics, currently only NB NV%
            - `type` 'builtin'
            - `metric` 'northbeam_nv_rate', required
        - `filters` union[]
          - union
            - EventPropertyFilter
              - …
            - EventSourceFilter
              - …
            - AdPlatformPropertyFilter
              - …
            - AdPlatformSourceFilter
              - …
            - TouchpointFilter
              - …
            - CustomDimensionFilter
              - …
            - AdPropertiesFilter
              - …
      - FormulaMetric
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
        - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
        - `type` 'formula'
        - `formula` string, required
      - InlineFormulaMetricInput: A formula over its own inputs: A is `inputs[0]`, B `inputs[1]`, ...
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
        - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
        - `type` 'inline_formula'
        - `formula` string, required
        - `inputs` union[], required
          - union
            - EventMetricInput
              - …
            - AdPlatformMetric
              - …

## Response `200`

Successful Response

- MetricTypesResponse
  - `metric_types` MetricDataType[], required

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-13** `118b0bdc2a6a`: 16 info
  - added `$city, $country_code, $state` discriminator mapping keys to the `metrics/items/oneOf[subschema #1: EventMetric]/aggregate/oneOf[subschema #3: CustomPropertyEventMetricAggregate]/property_name/anyOf[subschema #2]/` request property
  - added `$city, $country_code, $state` discriminator mapping keys to the `metrics/items/oneOf[subschema #1: EventMetric]/aggregate/oneOf[subschema #4: CustomPropertyProductMetricAggregate]/property_name/anyOf[subschema #2]/` request property
  - added `$city, $country_code, $state` discriminator mapping keys to the `metrics/items/oneOf[subschema #1: EventMetric]/filters/items/oneOf[subschema #1: EventPropertyFilter]/property_name/anyOf[subschema #2]/` request property
  - added `$city, $country_code, $state` discriminator mapping keys to the `metrics/items/oneOf[subschema #2: AdPlatformMetric]/filters/items/oneOf[subschema #1: EventPropertyFilter]/property_name/anyOf[subschema #2]/` request property
  - …12 more
- **2026-10-08** `090af3b1d0ff`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/runconverge/apis/runconverge-api/changes/insights/metrics/types/post.md)

---

[API](https://skmtc.dev/runconverge/apis/runconverge-api.md) - [All operations](https://skmtc.dev/runconverge/apis/runconverge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runconverge/apis/runconverge-api/revisions/f723e951cc0b?raw)
