diff --git a/content/en/api/v2/widgets/examples.json b/content/en/api/v2/widgets/examples.json index 3b50a60c3d0..0bed109f6aa 100644 --- a/content/en/api/v2/widgets/examples.json +++ b/content/en/api/v2/widgets/examples.json @@ -52,7 +52,7 @@ "filtered_total": "integer" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of widget resources.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Will be implemented soon. Currently always returns false.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widgets.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata about the search results.

\n
\n
\n
\n
\n
\n

created_by_anyone_total

\n
\n

int64

\n

Total number of widgets created by anyone.

\n
\n \n
\n
\n
\n
\n
\n

created_by_you_total

\n
\n

int64

\n

Total number of widgets created by the current user.

\n
\n \n
\n
\n
\n
\n
\n

favorited_by_you_total

\n
\n

int64

\n

Total number of widgets favorited by the current user.

\n
\n \n
\n
\n
\n
\n
\n

filtered_total

\n
\n

int64

\n

Total number of widgets matching the current filter criteria.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of widget resources.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Whether the current user has favorited this widget. Populated on get,\nbatch_get, update, and search responses; create responses always return\nfalse because a widget can only be favorited after it exists.\nFavoriting itself is performed through the shared favorites API, not\nthis service.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widgets.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata about the search results.

\n
\n
\n
\n
\n
\n

created_by_anyone_total

\n
\n

int64

\n

Total number of widgets created by anyone.

\n
\n \n
\n
\n
\n
\n
\n

created_by_you_total

\n
\n

int64

\n

Total number of widgets created by the current user.

\n
\n \n
\n
\n
\n
\n
\n

favorited_by_you_total

\n
\n

int64

\n

Total number of widgets favorited by the current user.

\n
\n \n
\n
\n
\n
\n
\n

filtered_total

\n
\n

int64

\n

Total number of widgets matching the current filter criteria.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -130,7 +130,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Will be implemented soon. Currently always returns false.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Whether the current user has favorited this widget. Populated on get,\nbatch_get, update, and search responses; create responses always return\nfalse because a widget can only be favorited after it exists.\nFavoriting itself is performed through the shared favorites API, not\nthis service.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -270,7 +270,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Will be implemented soon. Currently always returns false.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Whether the current user has favorited this widget. Populated on get,\nbatch_get, update, and search responses; create responses always return\nfalse because a widget can only be favorited after it exists.\nFavoriting itself is performed through the shared favorites API, not\nthis service.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -356,7 +356,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Will be implemented soon. Currently always returns false.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A widget resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a widget resource.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was created.

\n
\n \n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

The definition of a widget, including its type and configuration.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The display title of the widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Widget types that are allowed to be stored as individual records.\nThis is not a complete list of dashboard and notebook widget types. \nAllowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curve

Show 5 more,sankey,sunburst,timeseries,toplist,treemap

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_favorited [required]

\n
\n

boolean

\n

Whether the current user has favorited this widget. Populated on get,\nbatch_get, update, and search responses; create responses always return\nfalse because a widget can only be favorited after it exists.\nFavoriting itself is performed through the shared favorites API, not\nthis service.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

string

\n

ISO 8601 timestamp of when the widget was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

User-defined tags for organizing widgets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the widget.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the widget resource.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

The user who last modified the widget.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship data referencing a user resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Widgets resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of user resources related to the widget.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of an included user resource.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Users resource type.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 21c66675902..41ed9259582 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -82992,7 +82992,12 @@ components: definition: $ref: "#/components/schemas/WidgetDefinition" is_favorited: - description: "Will be implemented soon. Currently always returns false." + description: |- + Whether the current user has favorited this widget. Populated on get, + batch_get, update, and search responses; create responses always return + `false` because a widget can only be favorited after it exists. + Favoriting itself is performed through the shared favorites API, not + this service. example: false type: boolean modified_at: @@ -136337,7 +136342,17 @@ paths: - teams_read /api/v2/widgets/{experience_type}: get: - description: Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination. + description: |- + 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. operationId: SearchWidgets parameters: - description: The experience type for the widget. @@ -136373,8 +136388,14 @@ paths: schema: type: string - description: |- - Sort field for the results. Prefix with `-` for descending order. - Allowed values: `title`, `created_at`, `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. in: query name: sort schema: diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 55f96f42cca..aa8902f5d00 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -4988,7 +4988,7 @@ "summary": "Get user memberships" }, "SearchWidgets": { - "description": "Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination.", + "description": "Search and list widgets for a given experience type, with filtering, sorting, and pagination.\n\n**Response meta** carries totals scoped to the current filter:\n- `filtered_total` — widgets matching the filter.\n- `created_by_you_total` — among the matches, how many the current user created.\n- `favorited_by_you_total` — among the matches, how many the current user has favorited.\n- `created_by_anyone_total` — total widgets in the experience type, ignoring filters.\n\nEach returned widget includes `is_favorited` reflecting the current user's favorite status.\nFavoriting itself is performed through the shared favorites API, not this endpoint.", "summary": "Search widgets" }, "CreateWidget": {