---
title: "Get Insight"
method: GET
path: "/insights/{id}"
---

# Get Insight

`GET /insights/{id}`

## Request

- Base URL: `https://app.runconverge.com/api`
- URL: `https://app.runconverge.com/api/insights/{id}`
- Auth: none declared

## Path parameters

- `id` integer, required

## Headers

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

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- InsightResponseSchema
  - `created_at` string, date-time, required
  - `dashboards` DashboardInsightSchema[]
    - `dashboard_id` integer, required
    - `insight_id` integer, required
    - `layout` DashboardInsightLayout, required
      - `x` integer, required
      - `y` integer, required
      - `w` integer, required
      - `h` integer, required
  - `description` string, nullable
  - `id` integer, required
  - `name` string, required
  - `query` union, required
    - TrendsQueryOutput
      - `metrics` union[]
        - union
          - EventMetricOutput
            - `name` string, nullable
            - `hidden` boolean, nullable
            - `id` string
            - `filter` MetricFilter
              - …
            - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
            - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
            - `type` 'event'
            - `event_name` string, nullable
            - `aggregate` union, required
              - …
            - `filters` union[]
              - …
            - `attribution` ConvergeApiAttributionsAttribution
              - …
          - AdPlatformMetric
            - `name` string, nullable
            - `hidden` boolean, nullable
            - `id` string
            - `filter` MetricFilter
              - …
            - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
            - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
            - `type` 'ad_platform'
            - `column` union, required
              - …
            - `filters` union[]
              - …
          - FormulaMetric
            - `name` string, nullable
            - `hidden` boolean, nullable
            - `id` string
            - `filter` MetricFilter
              - …
            - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
            - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
            - `type` 'formula'
            - `formula` string, required
          - InlineFormulaMetricOutput: A formula over its own inputs: A is `inputs[0]`, B `inputs[1]`, ...
            - `name` string, nullable
            - `hidden` boolean, nullable
            - `id` string
            - `filter` MetricFilter
              - …
            - `data_type` 'numeric' | 'money' | 'percentage' | 'duration'
            - `performance_direction` 'increasing' | 'decreasing' | 'neutral'
            - `type` 'inline_formula'
            - `formula` string, required
            - `inputs` union[], required
              - …
      - `filters` AllOfFilters
        - `all_of` AnyOfFilters[]
          - `any_of` union[]
            - union
              - …
      - `breakdown` union
        - EventPropertyBreakdown
          - `type` 'event'
          - `scope` 'event' | 'profile' | 'session' | 'product', required
          - `property_name` union, required
            - string
            - union
              - …
          - `property_type` 'string' | 'numeric' | 'boolean' | 'list_of_strings', required
        - EventSourceBreakdown
          - `type` 'event_source'
        - AdPlatformSourceBreakdown
          - `type` 'ad_platform_source'
        - TouchpointBreakdown
          - `type` 'touchpoint'
          - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
        - CustomDimensionBreakdown
          - `type` 'custom_dimension'
          - `custom_dimension_id` integer, required
      - `date_range` DateRangeQuery, required
        - `since` union, required
          - string, date
          - string, date-time
          - string
        - `until` union
          - string, date
          - string, date-time
          - string
      - `time_granularity` 'hour' | 'day' | 'week' | 'month' | 'second'
      - `compare` union
        - true
        - string, date
        - string
      - `attribution` ConvergeApiAttributionsAttribution
        - `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
      - `type` 'trends'
    - CohortsQuery
      - `metric` CohortMetric
        - `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'
        - `aggregate` CohortEventMetricAggregate
          - `type` 'ltv' | 'churn_rate' | 'total' | 'retention_rate' | 'repurchase_rate'
      - `filters` AllOfFilters
        - `all_of` AnyOfFilters[]
          - `any_of` union[]
            - union
              - …
      - `breakdown` union
        - EventPropertyBreakdown
          - `type` 'event'
          - `scope` 'event' | 'profile' | 'session' | 'product', required
          - `property_name` union, required
            - string
            - union
              - …
          - `property_type` 'string' | 'numeric' | 'boolean' | 'list_of_strings', required
        - EventSourceBreakdown
          - `type` 'event_source'
        - AdPlatformSourceBreakdown
          - `type` 'ad_platform_source'
        - TouchpointBreakdown
          - `type` 'touchpoint'
          - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
        - CustomDimensionBreakdown
          - `type` 'custom_dimension'
          - `custom_dimension_id` integer, required
      - `date_range` DateRangeQuery
        - `since` union, required
          - string, date
          - string, date-time
          - string
        - `until` union
          - string, date
          - string, date-time
          - string
      - `period` integer, nullable
      - `time_granularity` 'hour' | 'day' | 'week' | 'month' | 'second', required
      - `attribution_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'
      - `type` 'cohorts'
  - `tags` string[]
  - `updated_at` string, date-time, required
  - `viz` 'area_chart' | 'bar_chart' | 'line_chart' | 'table' | 'total_number' | 'total_pie_chart' | 'total_bar_chart' | 'total_table' | 'cohort_table', required
  - `viz_options` InsightVizOptions
    - `breakdown_limit` integer, nullable
    - `currency` string, nullable
    - `legend_position` 'bottom' | 'left' | 'right' | 'top'
    - `show_comparison_bar` boolean
    - `show_legend` boolean
    - `show_totals` boolean
    - `show_values` boolean
    - `show_row_numbers` boolean
    - `sort_by` string, nullable
    - `use_compact_legend` boolean
    - `use_compact_notation` boolean, nullable
  - `creator` AccountSchema
    - `id` integer, required
    - `email` string, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `profile_picture_url` string, nullable
  - `editor` AccountSchema
    - `id` integer, required
    - `email` string, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `profile_picture_url` string, nullable
  - `favorited` boolean
  - `public_token` string, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-13** `118b0bdc2a6a`: 12 breaking, 12 info
  - added `#/components/schemas/ProfileCityProperty, #/components/schemas/ProfileStateProperty, #/components/schemas/ProfileCountryCodeProperty` to the `query/oneOf[subschema #1: TrendsQuery]/breakdown/anyOf[subschema #1]/oneOf[subschema #1: EventPropertyBreakdown]/property_name/anyOf[subschema #2]/` response property `oneOf` list for the response status `200`
  - added `#/components/schemas/ProfileCityProperty, #/components/schemas/ProfileStateProperty, #/components/schemas/ProfileCountryCodeProperty` to the `query/oneOf[subschema #1: TrendsQuery]/filters/all_of/items/any_of/items/oneOf[subschema #1: EventPropertyFilter]/property_name/anyOf[subschema #2]/` response property `oneOf` list for the response status `200`
  - added `#/components/schemas/ProfileCityProperty, #/components/schemas/ProfileStateProperty, #/components/schemas/ProfileCountryCodeProperty` to the `query/oneOf[subschema #1: TrendsQuery]/metrics/items/oneOf[subschema #1: EventMetric]/aggregate/oneOf[subschema #3: CustomPropertyEventMetricAggregate]/property_name/anyOf[subschema #2]/` response property `oneOf` list for the response status `200`
  - added `#/components/schemas/ProfileCityProperty, #/components/schemas/ProfileStateProperty, #/components/schemas/ProfileCountryCodeProperty` to the `query/oneOf[subschema #1: TrendsQuery]/metrics/items/oneOf[subschema #1: EventMetric]/aggregate/oneOf[subschema #4: CustomPropertyProductMetricAggregate]/property_name/anyOf[subschema #2]/` response property `oneOf` list for the response status `200`
  - …20 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/runconverge/apis/runconverge-api/changes/insights/:id/get.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)