Widgets
Get Widget (POST)
Returns the requested widget.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
idstring
The requested widget's ID.
Format
textResponse Body
curl -X POST "https://api.devrev.ai/widgets.get" \ -H "Content-Type: application/json" \ -d '{ "id": "string" }'{
"widget": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"data_sources": [
{
"type": "api",
"api": {
"include": [
{
"type": "issue",
"display_id": "string",
"id": "string",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"stage": {
"name": "string",
"stage": {
"display_id": "string",
"id": "string",
"name": "string"
}
},
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
},
"title": "string",
"priority": "p0",
"priority_v2": {
"id": 0,
"label": "string",
"ordinal": 0
},
"sprint": {
"type": "curated",
"end_date": "2023-01-01T12:00:00.000Z",
"id": "string",
"name": "string",
"start_date": "2023-01-01T12:00:00.000Z",
"state": "active"
}
}
],
"is_custom_leaf_type": true,
"leaf_type": "string",
"subtypes": [
"string"
]
},
"data_source": "string",
"dimensions": [
{
"type": "custom_field",
"custom_field": {
"leaf_type": "string",
"name": "string",
"subtype": "string"
},
"devrev_schema": {
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"create_view": {
"is_hidden": true
},
"decimal_places": 0,
"detail_view": {
"is_hidden": true
},
"display_name": "string",
"filter_view": {
"is_hidden": true
},
"group_name": "string",
"is_active_in_detail_view": true,
"is_bulk_action_enabled": true,
"is_currency_field": true,
"is_groupable": true,
"is_hidden": true,
"is_hidden_during_create": true,
"is_read_only": true,
"is_required": true,
"is_shown_in_summary": true,
"is_sortable": true,
"list_view": {
"is_hidden": true
},
"order": 0,
"placeholder": "string",
"summary_view": {
"is_hidden": true
},
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
},
"has_custom_expression": true,
"is_derived": true,
"meerkat_schema": {
"type": "boolean",
"function": {
"type": "avg"
},
"sql_expression": "string",
"timestamp_rollup": "day"
},
"reference_name": "string"
}
],
"external_data_source": {
"dataset_projections": [
{
"columns": [
{
"custom_field": {
"leaf_type": "string",
"name": "string",
"subtype": "string"
},
"name": "string"
}
],
"dataset": "string"
}
],
"id": "string"
},
"joins": [
{}
],
"measures": [
{
"type": "custom_field",
"custom_field": {
"leaf_type": "string",
"name": "string",
"subtype": "string"
},
"devrev_schema": {
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"create_view": {
"is_hidden": true
},
"decimal_places": 0,
"detail_view": {
"is_hidden": true
},
"display_name": "string",
"filter_view": {
"is_hidden": true
},
"group_name": "string",
"is_active_in_detail_view": true,
"is_bulk_action_enabled": true,
"is_currency_field": true,
"is_groupable": true,
"is_hidden": true,
"is_hidden_during_create": true,
"is_read_only": true,
"is_required": true,
"is_shown_in_summary": true,
"is_sortable": true,
"list_view": {
"is_hidden": true
},
"order": 0,
"placeholder": "string",
"summary_view": {
"is_hidden": true
},
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
},
"has_custom_expression": true,
"is_derived": true,
"meerkat_schema": {
"type": "boolean",
"function": {
"type": "avg"
},
"sql_expression": "string",
"timestamp_rollup": "day"
},
"reference_name": "string"
}
],
"oasis": {
"datasets": [
"string"
],
"projections": [
{
"columns": [
{
"custom_field": {
"leaf_type": "string",
"name": "string",
"subtype": "string"
},
"name": "string"
}
],
"dataset": "string"
}
],
"sql_query": "string"
},
"reference_name": "string"
}
],
"description": "string",
"is_draft": true,
"is_system": true,
"layout": [
{
"layout": [
{
"layout": [],
"position": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
},
"reference_id": "string"
}
],
"position": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
},
"reference_id": "string"
}
],
"name": "string",
"sub_widgets": [
{
"query": {
"dimensions": [
"string"
],
"filters": [
{}
],
"joins": [
{
"path": [
"string"
]
}
],
"limit": 0,
"measures": [
"string"
],
"order_by": [
{
"direction": "ascending",
"reference_name": "string"
}
]
},
"reference_id": "string",
"visualization": {
"type": "bar",
"bar": {
"is_stacked": true,
"scrollbar": {},
"show_data_labels": true,
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
]
},
"column": {
"is_stacked": true,
"scrollbar": {},
"show_data_labels": true,
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
]
},
"donut": {
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": {
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
},
"heatmap": {
"color": "string",
"x": {
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
},
"y": {
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
},
"z": {
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
},
"kanban": {
"card_attributes": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"order": 0,
"position": "body",
"reference_name": "string"
}
],
"group_by": [
{
"key": "string",
"limit": 0
}
]
},
"line": {
"is_stacked": true,
"show_data_labels": true,
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_area_filled": true,
"is_hidden": true,
"is_spline": true,
"label": "string",
"marker": true,
"reference_name": "string"
}
]
},
"metric": {
"pvp": {
"enabled": true,
"invert_correlation_color": true
},
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
]
},
"packed_bubble": {
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
]
},
"pie": {
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": {
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
},
"rich_text": {
"content": {}
},
"scatter": {
"x": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
],
"y": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"label": "string",
"reference_name": "string"
}
]
},
"table": {
"columns": [
{
"color": {
"type": "key_lookup",
"key_lookup": [
{
"key": "string",
"value": "string"
}
],
"static": "string"
},
"drill_throughs": [
{}
],
"is_hidden": true,
"is_movable": true,
"is_pinned": true,
"is_resizable": true,
"is_sortable": true,
"is_visibility_togglable": true,
"label": "string",
"lock_position": "left",
"max_width": 0,
"min_width": 0,
"order": 0,
"pin_position": "left",
"reference_name": "string",
"width": 0
}
],
"group_by": [
{
"key": "string",
"limit": 0
}
]
}
}
}
],
"title": "string"
}
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}