---
title: "Get Public Dashboard"
method: GET
path: "/dashboards/public/{dashboard_token}"
---

# Get Public Dashboard

`GET /dashboards/public/{dashboard_token}`

Get a dashboard by its public token. This endpoint is public and does not require authentication.

## Path parameters

- `dashboard_token` string, required

## Response `200`

Successful Response

- PublicDashboardResponseSchema
  - `insights` PublicDashboardInsightSchema[]
    - `dashboard_id` integer, required
    - `insight_id` integer, required
    - `layout` DashboardInsightLayout, required
      - `x` integer, required
      - `y` integer, required
      - `w` integer, required
      - `h` integer, required
    - `insight` PublicInsightSchema, required
      - `created_at` string, date-time, required
      - `description` string, nullable
      - `id` integer, required
      - `name` string, required
      - `query` union, required
        - TrendsQuery
          - `metrics` union[]
            - union
              - …
          - `filters` AllOfFilters
            - `all_of` AnyOfFilters[]
              - …
          - `breakdown` union
            - EventPropertyBreakdown
              - …
            - EventSourceBreakdown
              - …
            - AdPlatformSourceBreakdown
              - …
            - TouchpointBreakdown
              - …
            - CustomDimensionBreakdown
              - …
          - `date_range` DateRangeQuery, required
            - `since` union, required
              - …
            - `until` union
              - …
          - `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
              - …
            - `aggregate` CohortEventMetricAggregate
              - …
          - `filters` AllOfFilters
            - `all_of` AnyOfFilters[]
              - …
          - `breakdown` union
            - EventPropertyBreakdown
              - …
            - EventSourceBreakdown
              - …
            - AdPlatformSourceBreakdown
              - …
            - TouchpointBreakdown
              - …
            - CustomDimensionBreakdown
              - …
          - `date_range` DateRangeQuery
            - `since` union, required
              - …
            - `until` union
              - …
          - `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
  - `created_at` string, date-time, required
  - `description` string, nullable
  - `id` integer, required
  - `name` string, required
  - `query_override` DashboardInsightQuery, required
    - `filters` AnyOfFilters[], nullable
      - `any_of` union[]
        - union
          - EventPropertyFilter
            - `type` 'event'
            - `scope` 'event' | 'profile' | 'session' | 'product', required
            - `property_name` union, required
              - …
            - `operator` union, required
              - …
          - EventSourceFilter
            - `type` 'event_source'
            - `datasource_id` union
              - …
            - `pixel_id` union
              - …
          - AdPlatformPropertyFilter
            - `type` 'ad_platform'
            - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
            - `operator` union, required
              - …
          - AdPlatformSourceFilter
            - `type` 'ad_platform_source'
            - `ad_platform_id` union, required
              - …
          - TouchpointFilter
            - `type` 'touchpoint'
            - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
            - `operator` union, required
              - …
            - `legacy` boolean
          - CustomDimensionFilter
            - `type` 'custom_dimension'
            - `custom_dimension_id` integer, required
            - `values` string[], required
          - AdPropertiesFilter
            - `type` 'ad_properties'
            - `property` 'ad_created_at' | 'ad_status' | 'ad_landing_url', required
            - `operator` union, required
              - …
    - `custom_dimensions` Selection[]
      - `id` integer, required
      - `values` string[], required
    - `date_range` DateRangeQuery
      - `since` union, required
        - string, date
        - string, date-time
        - string
      - `until` union
        - string, date
        - string, date-time
        - string
    - `time_granularity` 'hour' | 'day' | 'week' | 'month' | 'second'
    - `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
    - `currency` string, nullable
  - `tags` string[]
  - `updated_at` string, date-time, required
  - `ui_config` AnalyticsUIConfig
    - `start_of_week` 0 | 1
    - `timezone` string
    - `currency` string
  - `workspace_name` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/runconverge/apis/fastapi.md) · [All operations](https://skmtc.dev/runconverge/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runconverge/fastapi/revisions/1452e350bd1d/schema)