Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Widgets

Search widgets

Search and list widgets for a given experience type, with filtering, sorting, and pagination.

Response meta carries totals scoped to the current filter:

  • filtered_total — widgets matching the filter.
  • created_by_you_total — among the matches, how many the current user created.
  • favorited_by_you_total — among the matches, how many the current user has favorited.
  • created_by_anyone_total — total widgets in the experience type, ignoring filters.

Each returned widget includes is_favorited reflecting the current user's favorite status. Favoriting itself is performed through the shared favorites API, not this endpoint.

get/api/v2/widgets/{experience_type}

Path parameters

experience_type'ccm_reports' | 'logs_reports' | 'csv_reports' | 'product_analytics' required

Widget experience types that differentiate between the products using the specific widget.

Example:ccm_reports

The experience type for the widget.

Query parameters

filter[widgetType]'bar_chart' | 'change' | 'cloud_cost_summary' | 'cohort' | 'funnel' | 'geomap' | 'list_stream' | 'query_table' | 'query_value' | 'retention_curve' | 'sankey' | 'sunburst' | 'timeseries' | 'toplist' | 'treemap'

Widget types that are allowed to be stored as individual records. This is not a complete list of dashboard and notebook widget types.

Example:bar_chart

Filter widgets by widget type.

filter[creatorHandle]string
Example:john.doe@example.com

Filter widgets by the email handle of the creator.

filter[isFavorited]boolean

Filter to only widgets favorited by the current user.

filter[title]string

Filter widgets by title (substring match).

filter[tags]string

Filter widgets by tags. Format as bracket-delimited CSV, e.g. [tag1,tag2].

sortstring
Example:-modified_at

Sort field for the results.

title, created_at, modified_at — both ascending and descending are supported. Use the bare field name for ascending (e.g. sort=title) or prefix with - for descending (e.g. sort=-modified_at).

is_favorited — returns favorites-first ordering (favorited widgets first, then the rest). Direction is fixed; the - prefix is ignored for this field.

page[number]integer

Page number for pagination (0-indexed).

page[size]integer

Number of widgets per page.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T00:00:00.000Z",
        "definition": {
          "title": "My Widget",
          "type": "bar_chart"
        },
        "modified_at": "2024-01-15T00:00:00.000Z",
        "tags": [
          "team:my-team"
        ]
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "relationships": {
        "created_by": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "type": "users"
          }
        },
        "modified_by": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "type": "users"
          }
        }
      },
      "type": "widgets"
    }
  ],
  "included": [
    {
      "attributes": {
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "users"
    }
  ]
}