Creates a dashboard item, a widget that displays one query in one visualization, and assigns it to a dashboard. You set the query type, the data source, the data configuration, and the visualization type.

When to use it

Use it to add a widget to a dashboard from code. Create the dashboard first with Create a dashboard.

Required parameters

• name (body): the name of the item.
• query_type (body): the kind of query: raw_data, statistics, time_series, or distribution.
• datasource (body): where the data comes from: datasets or events.
• data_config (body): the query configuration: a general query, or a comparison of two distributions.
• dashboard_id (body): the ID of the dashboard the item belongs to.
• item_metadata (body): a JSON object of item metadata.
• visualization_type (body): how the item is drawn: table, line_graph, bar_plot, time_series, histogram, or query_value.

Response

A successful call returns 201 Created with the new DashboardItem object, including its id, dashboard_id, query type, data source, and data configuration.

Related: Get a dashboard item, Update a dashboard item, List dashboard items, Create a dashboard