---
title: "Get Widget"
method: GET
path: "/v1/widgets/{id}"
tags: ["Widgets"]
---

# Get Widget

`GET /v1/widgets/{id}`

## Request

- Base URL: `https://api.oviond.com`
- URL: `https://api.oviond.com/v1/widgets/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Get a single widget by ID.

## Path parameters

- `id` string, required

## Response `200`

Widget

- WidgetResponse
  - `success` true, required
  - `data` Widget, required
    - `source_type` 'project' | 'template', nullable
    - `source_id` string, nullable
    - `page_id` string, nullable
    - `client_id` string, nullable
    - `type` 'DATA' | 'TEXT' | 'IMAGE' | 'HTML' | 'VIDEO' | 'EMBED' | 'TITLE' | 'BUTTON' | 'GOAL', nullable
    - `chart` 'table' | 'score' | 'area' | 'line' | 'bar' | 'column' | 'pie' | 'donut' | 'funnel' | 'map' | 'areaspline' | 'spline' | 'stacked_area' | 'percentage_area' | 'stacked_column' | 'stacked_bar' | '100_stacked_column' | '3d_bar' | '3d_column' | '3d_pie' | '3d_donut' | 'funnel3d' | 'custom', nullable
    - `chart_type` 'table' | 'score' | 'area' | 'line' | 'bar' | 'column' | 'pie' | 'donut' | 'funnel' | 'map' | 'areaspline' | 'spline' | 'stacked_area' | 'percentage_area' | 'stacked_column' | 'stacked_bar' | '100_stacked_column' | '3d_bar' | '3d_column' | '3d_pie' | '3d_donut' | 'funnel3d' | 'custom', nullable
    - `chart_group` 'line' | 'area' | 'bar' | 'pie' | 'funnel' | 'table' | 'score' | 'map' | 'column' | 'donut' | 'column_bar_charts' | 'line_area_charts' | 'pie_donut_charts' | 'scorecard', nullable
    - `state` 'loading' | 'LOADING' | 'active' | 'ACTIVE' | 'error' | 'ERROR' | 'NO_DATA' | 'demo' | 'DEMO', nullable
    - `title` string, nullable
    - `text` string, nullable
    - `name` string, nullable
    - `auto_generated_name` string, nullable
    - `heading` 'h1' | 'h2' | 'h3' | 'h4' | 'h5', nullable
    - `align` 'left' | 'center' | 'right' | 'justify', nullable
    - `link` string, nullable
    - `link_url` string, nullable
    - `image_fit` 'object-contain' | 'object-cover' | 'object-fill' | 'object-none', nullable
    - `embed_type` 'URL' | 'IFRAME' | 'HTML', nullable
    - `embed_url` string, nullable
    - `embed_iframe` string, nullable
    - `embed_html` string, nullable
    - `size` string, nullable
    - `description` string, nullable
    - `content` string, nullable
    - `src` string, nullable
    - `url` string, nullable
    - `icon` string, nullable
    - `target` string, nullable
    - `image_link_url` string, nullable
    - `x` number, nullable
    - `y` number, nullable
    - `width` number, nullable
    - `height` number, nullable
    - `is_secondary` boolean, nullable
    - `icon_position` 'top' | 'right' | 'bottom' | 'left' | 'none', nullable
    - `options_3d` boolean, nullable
    - `kpi` boolean, nullable
    - `blended` boolean, nullable
    - `row_limit` '5' | '10' | '25' | '50' | '100' | '500' | 'all', nullable
    - `comparison_display` 'previous' | 'change' | 'both', nullable
    - `sort_order` string, nullable
    - `sort_by` string, nullable
    - `column_widths` object, nullable
    - `b_height` string, nullable
    - `legend_position` 'top' | 'right' | 'bottom' | 'left' | 'none', nullable
    - `invert_y_axis` boolean, nullable
    - `show_header` boolean, nullable
    - `show_name` boolean, nullable
    - `show_icon` boolean, nullable
    - `show_date` boolean, nullable
    - `show_grid_lines` boolean, nullable
    - `show_legends` boolean, nullable
    - `show_x_axis` boolean, nullable
    - `show_y_axis` boolean, nullable
    - `show_trendline` boolean, nullable
    - `show_totals` boolean, nullable
    - `show_search` boolean, nullable
    - `show_table_filters` boolean, nullable
    - `show_logarithmic` boolean, nullable
    - `show_multiple_axes` boolean, nullable
    - `show_custom_date_range` boolean, nullable
    - `show_description` boolean, nullable
    - `show_container` boolean, nullable
    - `show_label_list` boolean, nullable
    - `show_chart` boolean, nullable
    - `expand_rows` boolean, nullable
    - `datasource_id` 'advanced-web-ranking' | 'ac' | 'adroll' | 'ahrefs' | 'basecamp' | 'brightlocal' | 'call-rail' | 'drip' | 'keywords' | 'sendin-blue' | 'sendgrid' | 'moosend' | 'mailer-lite' | 'pingdom' | 'uptime-robot' | 'piwik-pro' | 'wordpress' | 'pabbly-connect' | 'ment' | 'twilio' | 'switchy' | 'vimeo' | 'pinterest' | 'pinterest-ads' | 'gtres' | 'paypal' | 'gps' | 'gs' | 'CUSTOM_IMPORT' | 'CUSTOM_DATA' | 'CALCULATION' | 'GOALS' | 'str' | 'wistia' | 'ca-mon' | 'convertkit' | 'woocommerce' | 'xero' | 'matomo' | 'go-high-level' | 'wcs' | 'bing-webmaster-tools' | 'pipedrive' | 'salesforce' | 'tiktok' | 'tiktok-ads' | 'twr' | 'twr-ads' | 'spf' | 'ytbe' | 'google-local-services-ads' | 'klaviyo' | 'gsh' | 'ga4' | 'lkdin-ads' | 'lkdin-pg' | 'mlchmp' | 'inst-ads' | 'inst' | 'fb-ads' | 'fb-pg' | 'gmb' | 'serpstat' | 'hubspot' | 'gadw' | 'sem-rush' | 'se-ranking' | 'microsoft-ads' | 'plausible' | 'snapchat-ads' | 'microsoft-clarity' | 'serp-watch' | 'vbout' | 'moz' | 'chatgpt-ads' | 'omnisend' | 'airtable' | 'nozzle' | 'surnex' | 'jira' | 'clickup' | 'make' | 'freshdesk' | 'chart-mogul' | 'amplitude' | 'harvest' | 'zoho-crm' | 'clockify' | 'adtraction' | 'shopify' | 'copper' | 'help-scout-docs' | 'close-crm' | 'simplesat' | 'help-scout-mailbox' | 'demo', nullable
    - `datasource_type` 'DATASOURCE' | 'CALCULATION' | 'CUSTOM_DATA' | 'CUSTOM_IMPORT' | 'GOALS', nullable
    - `data_view` string, nullable
    - `metrics` MetricSelection[], nullable
      - `value` string, required
      - `label` string
      - `data_view` string
    - `dimensions` DimensionSelection[], nullable
      - `value` string, required
      - `label` string
      - `data_view` string
    - `filters` WidgetFilter[], nullable
      - `id` union
        - number
        - string
      - `field` string
      - `operator` string: Canonical: equals, not_equals, contains, not_contains, starts_with, ends_with, greater_than, less_than, greater_than_or_equal, less_than_or_equal (vendor tokens also accepted).
      - `value` union
        - string
        - number
        - boolean
        - unknown[]
          - unknown
      - `logicalOperator` 'and' | 'or'
    - `advanced` object, nullable
    - `currency` union: ISO 4217 currency code (e.g. "USD") or a full { code, symbol, iso } object.
      - object
        - `code` string, required
        - `symbol` string, required
        - `iso` string, nullable
      - string
    - `date_range` object, nullable
      - `text` 'Today' | 'Yesterday' | 'Last 7 Days' | 'Last 30 Days' | 'Last 60 Days' | 'Custom Days' | 'This Month' | 'Last Month' | 'Custom Months' | 'Last 2 Months' | 'Last 3 Months' | 'Last 12 Months' | 'This Year' | 'Last Year' | 'Custom'
      - `compare` 'None' | 'Period' | 'Month' | 'Year' | 'Custom'
      - `include_today` boolean
      - `current_start` string
      - `current_end` string
      - `previous_start` string
      - `previous_end` string
      - `custom_days` number
      - `custom_months` number
    - `current_data` object[], nullable
    - `current_summary` object, nullable
    - `previous_data` object[], nullable
    - `previous_summary` object, nullable
    - `series_fetched_at` string, nullable
    - `error_status` integer, nullable
    - `created_at` unknown
    - `id` string, required
    - `account_id` string, required

## Other responses

- `404`: Not found

## Changes

- **2026-10-20** `4cb0a07daf41`: 1 info
  - removed the `amazon-advertising` enum value from the `data/datasource_id` response property for the response status `200`

[Operation history](https://skmtc.dev/oviond/apis/oviond-backend-api/changes/v1/widgets/:id/get.md)

---

[API](https://skmtc.dev/oviond/apis/oviond-backend-api.md) · [All operations](https://skmtc.dev/oviond/apis/oviond-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oviond/apis/oviond-backend-api/revisions/4cb0a07daf41?raw)