Get Widget

Beta

GET

https://api.devrev.ai/widgets.get

GET

/widgets.get

1 import requests
2 
3 url = "https://api.devrev.ai/widgets.get"
4 
5 querystring = {"id":"id"}
6 
7 headers = {"Authorization": "Bearer <token>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

Try it

200Retrieved

1 {
2   "widget": {
3     "description": "string",
4     "id": "string",
5     "layout": [
6       {
7         "reference_id": "string",
8         "layout": [
9           null
10         ],
11         "position": {
12           "height": 1,
13           "width": 1,
14           "x": 1,
15           "y": 1
16         }
17       }
18     ],
19     "sub_widgets": [
20       {
21         "reference_id": "string",
22         "visualization": {
23           "type": "bar",
24           "bar": {
25             "x": [
26               {
27                 "reference_name": "string",
28                 "color": {
29                   "type": "key_lookup",
30                   "key_lookup": [
31                     {
32                       "key": "string",
33                       "value": "string"
34                     }
35                   ],
36                   "static": "string"
37                 },
38                 "drill_throughs": [
39                   {}
40                 ],
41                 "is_hidden": true,
42                 "label": "string"
43               }
44             ],
45             "y": [
46               {
47                 "reference_name": "string",
48                 "color": {
49                   "type": "key_lookup",
50                   "key_lookup": [
51                     {
52                       "key": "string",
53                       "value": "string"
54                     }
55                   ],
56                   "static": "string"
57                 },
58                 "drill_throughs": [
59                   {}
60                 ],
61                 "is_hidden": true,
62                 "label": "string"
63               }
64             ],
65             "is_stacked": true,
66             "scrollbar": {},
67             "show_data_labels": true
68           },
69           "column": {
70             "x": [
71               {
72                 "reference_name": "string",
73                 "color": {
74                   "type": "key_lookup",
75                   "key_lookup": [
76                     {
77                       "key": "string",
78                       "value": "string"
79                     }
80                   ],
81                   "static": "string"
82                 },
83                 "drill_throughs": [
84                   {}
85                 ],
86                 "is_hidden": true,
87                 "label": "string"
88               }
89             ],
90             "y": [
91               {
92                 "reference_name": "string",
93                 "color": {
94                   "type": "key_lookup",
95                   "key_lookup": [
96                     {
97                       "key": "string",
98                       "value": "string"
99                     }
100                   ],
101                   "static": "string"
102                 },
103                 "drill_throughs": [
104                   {}
105                 ],
106                 "is_hidden": true,
107                 "label": "string"
108               }
109             ],
110             "is_stacked": true,
111             "scrollbar": {},
112             "show_data_labels": true
113           },
114           "donut": {
115             "x": [
116               {
117                 "reference_name": "string",
118                 "color": {
119                   "type": "key_lookup",
120                   "key_lookup": [
121                     {
122                       "key": "string",
123                       "value": "string"
124                     }
125                   ],
126                   "static": "string"
127                 },
128                 "drill_throughs": [
129                   {}
130                 ],
131                 "is_hidden": true,
132                 "label": "string"
133               }
134             ],
135             "y": {
136               "reference_name": "string",
137               "color": {
138                 "type": "key_lookup",
139                 "key_lookup": [
140                   {
141                     "key": "string",
142                     "value": "string"
143                   }
144                 ],
145                 "static": "string"
146               },
147               "drill_throughs": [
148                 {}
149               ],
150               "is_hidden": true,
151               "label": "string"
152             }
153           },
154           "heatmap": {
155             "x": {
156               "reference_name": "string",
157               "color": {
158                 "type": "key_lookup",
159                 "key_lookup": [
160                   {
161                     "key": "string",
162                     "value": "string"
163                   }
164                 ],
165                 "static": "string"
166               },
167               "drill_throughs": [
168                 {}
169               ],
170               "is_hidden": true,
171               "label": "string"
172             },
173             "y": {
174               "reference_name": "string",
175               "color": {
176                 "type": "key_lookup",
177                 "key_lookup": [
178                   {
179                     "key": "string",
180                     "value": "string"
181                   }
182                 ],
183                 "static": "string"
184               },
185               "drill_throughs": [
186                 {}
187               ],
188               "is_hidden": true,
189               "label": "string"
190             },
191             "z": {
192               "reference_name": "string",
193               "color": {
194                 "type": "key_lookup",
195                 "key_lookup": [
196                   {
197                     "key": "string",
198                     "value": "string"
199                   }
200                 ],
201                 "static": "string"
202               },
203               "drill_throughs": [
204                 {}
205               ],
206               "is_hidden": true,
207               "label": "string"
208             },
209             "color": "string"
210           },
211           "kanban": {
212             "card_attributes": [
213               {
214                 "reference_name": "string",
215                 "color": {
216                   "type": "key_lookup",
217                   "key_lookup": [
218                     {
219                       "key": "string",
220                       "value": "string"
221                     }
222                   ],
223                   "static": "string"
224                 },
225                 "drill_throughs": [
226                   {}
227                 ],
228                 "is_hidden": true,
229                 "label": "string",
230                 "order": 1,
231                 "position": "body"
232               }
233             ],
234             "group_by": [
235               {
236                 "key": "string",
237                 "limit": 1
238               }
239             ]
240           },
241           "line": {
242             "x": [
243               {
244                 "reference_name": "string",
245                 "color": {
246                   "type": "key_lookup",
247                   "key_lookup": [
248                     {
249                       "key": "string",
250                       "value": "string"
251                     }
252                   ],
253                   "static": "string"
254                 },
255                 "drill_throughs": [
256                   {}
257                 ],
258                 "is_hidden": true,
259                 "label": "string"
260               }
261             ],
262             "y": [
263               {
264                 "reference_name": "string",
265                 "color": {
266                   "type": "key_lookup",
267                   "key_lookup": [
268                     {
269                       "key": "string",
270                       "value": "string"
271                     }
272                   ],
273                   "static": "string"
274                 },
275                 "drill_throughs": [
276                   {}
277                 ],
278                 "is_area_filled": true,
279                 "is_hidden": true,
280                 "is_spline": true,
281                 "label": "string",
282                 "marker": true
283               }
284             ],
285             "is_stacked": true,
286             "show_data_labels": true
287           },
288           "metric": {
289             "y": [
290               {
291                 "reference_name": "string",
292                 "color": {
293                   "type": "key_lookup",
294                   "key_lookup": [
295                     {
296                       "key": "string",
297                       "value": "string"
298                     }
299                   ],
300                   "static": "string"
301                 },
302                 "drill_throughs": [
303                   {}
304                 ],
305                 "is_hidden": true,
306                 "label": "string"
307               }
308             ],
309             "pvp": {
310               "enabled": true,
311               "invert_correlation_color": true
312             }
313           },
314           "packed_bubble": {
315             "x": [
316               {
317                 "reference_name": "string",
318                 "color": {
319                   "type": "key_lookup",
320                   "key_lookup": [
321                     {
322                       "key": "string",
323                       "value": "string"
324                     }
325                   ],
326                   "static": "string"
327                 },
328                 "drill_throughs": [
329                   {}
330                 ],
331                 "is_hidden": true,
332                 "label": "string"
333               }
334             ],
335             "y": [
336               {
337                 "reference_name": "string",
338                 "color": {
339                   "type": "key_lookup",
340                   "key_lookup": [
341                     {
342                       "key": "string",
343                       "value": "string"
344                     }
345                   ],
346                   "static": "string"
347                 },
348                 "drill_throughs": [
349                   {}
350                 ],
351                 "is_hidden": true,
352                 "label": "string"
353               }
354             ]
355           },
356           "pie": {
357             "x": [
358               {
359                 "reference_name": "string",
360                 "color": {
361                   "type": "key_lookup",
362                   "key_lookup": [
363                     {
364                       "key": "string",
365                       "value": "string"
366                     }
367                   ],
368                   "static": "string"
369                 },
370                 "drill_throughs": [
371                   {}
372                 ],
373                 "is_hidden": true,
374                 "label": "string"
375               }
376             ],
377             "y": {
378               "reference_name": "string",
379               "color": {
380                 "type": "key_lookup",
381                 "key_lookup": [
382                   {
383                     "key": "string",
384                     "value": "string"
385                   }
386                 ],
387                 "static": "string"
388               },
389               "drill_throughs": [
390                 {}
391               ],
392               "is_hidden": true,
393               "label": "string"
394             }
395           },
396           "rich_text": {
397             "content": {}
398           },
399           "scatter": {
400             "x": [
401               {
402                 "reference_name": "string",
403                 "color": {
404                   "type": "key_lookup",
405                   "key_lookup": [
406                     {
407                       "key": "string",
408                       "value": "string"
409                     }
410                   ],
411                   "static": "string"
412                 },
413                 "drill_throughs": [
414                   {}
415                 ],
416                 "is_hidden": true,
417                 "label": "string"
418               }
419             ],
420             "y": [
421               {
422                 "reference_name": "string",
423                 "color": {
424                   "type": "key_lookup",
425                   "key_lookup": [
426                     {
427                       "key": "string",
428                       "value": "string"
429                     }
430                   ],
431                   "static": "string"
432                 },
433                 "drill_throughs": [
434                   {}
435                 ],
436                 "is_hidden": true,
437                 "label": "string"
438               }
439             ]
440           },
441           "table": {
442             "columns": [
443               {
444                 "reference_name": "string",
445                 "color": {
446                   "type": "key_lookup",
447                   "key_lookup": [
448                     {
449                       "key": "string",
450                       "value": "string"
451                     }
452                   ],
453                   "static": "string"
454                 },
455                 "drill_throughs": [
456                   {}
457                 ],
458                 "is_hidden": true,
459                 "is_movable": true,
460                 "is_pinned": true,
461                 "is_resizable": true,
462                 "is_sortable": true,
463                 "is_visibility_togglable": true,
464                 "label": "string",
465                 "lock_position": "left",
466                 "max_width": 1,
467                 "min_width": 1,
468                 "order": 1,
469                 "pin_position": "left",
470                 "width": 1
471               }
472             ],
473             "group_by": [
474               {
475                 "key": "string",
476                 "limit": 1
477               }
478             ]
479           }
480         },
481         "query": {
482           "dimensions": [
483             "string"
484           ],
485           "filters": [
486             {}
487           ],
488           "joins": [
489             {
490               "path": [
491                 "string"
492               ]
493             }
494           ],
495           "limit": 1,
496           "measures": [
497             "string"
498           ],
499           "order_by": [
500             {
501               "direction": "ascending",
502               "reference_name": "string"
503             }
504           ]
505         }
506       }
507     ],
508     "title": "string",
509     "created_by": {
510       "display_id": "string",
511       "id": "string",
512       "display_name": "string",
513       "display_picture": {
514         "display_id": "string",
515         "id": "string",
516         "file": {
517           "type": "string",
518           "name": "string",
519           "size": 1
520         }
521       },
522       "email": "string",
523       "full_name": "string",
524       "state": "active"
525     },
526     "created_date": "2023-01-01T12:00:00.000Z",
527     "data_sources": [
528       {
529         "type": "api",
530         "reference_name": "string",
531         "api": {
532           "include": [
533             {
534               "display_id": "string",
535               "id": "string",
536               "owned_by": [
537                 {
538                   "display_id": {},
539                   "id": {},
540                   "display_name": {},
541                   "display_picture": {},
542                   "email": {},
543                   "full_name": {},
544                   "state": {}
545                 }
546               ],
547               "stage": {
548                 "name": "string",
549                 "stage": {
550                   "display_id": "string",
551                   "id": "string",
552                   "name": "string"
553                 }
554               },
555               "sync_metadata": {
556                 "external_reference": "string",
557                 "origin_system": "string"
558               },
559               "title": "string",
560               "priority": "p0",
561               "priority_v2": {
562                 "id": 1,
563                 "label": "string",
564                 "ordinal": 1
565               },
566               "sprint": {
567                 "type": "curated",
568                 "end_date": "2023-01-01T12:00:00.000Z",
569                 "id": "string",
570                 "name": "string",
571                 "start_date": "2023-01-01T12:00:00.000Z",
572                 "state": "active"
573               }
574             }
575           ],
576           "is_custom_leaf_type": true,
577           "leaf_type": "string",
578           "subtypes": [
579             "string"
580           ]
581         },
582         "data_source": "string",
583         "dimensions": [
584           {
585             "devrev_schema": {
586               "description": "string",
587               "is_filterable": true,
588               "is_immutable": true,
589               "is_pii": true,
590               "is_required": true,
591               "mfz": {},
592               "name": "string",
593               "oasis": {},
594               "origin": "string",
595               "ui": {
596                 "client_overrides": [
597                   {
598                     "client_name": "string",
599                     "decimal_places": 1,
600                     "display_name": "string",
601                     "is_groupable": true,
602                     "is_hidden": true,
603                     "is_required": true,
604                     "order": 1,
605                     "placeholder": "string",
606                     "tooltip": "string",
607                     "use_shorthand_notation": true,
608                     "view_overrides": [
609                       {
610                         "decimal_places": 1,
611                         "display_name": "string",
612                         "is_groupable": true,
613                         "is_hidden": true,
614                         "is_required": true,
615                         "order": 1,
616                         "placeholder": "string",
617                         "tooltip": "string",
618                         "use_shorthand_notation": true,
619                         "view_name": "string"
620                       }
621                     ]
622                   }
623                 ],
624                 "create_view": {
625                   "is_hidden": true
626                 },
627                 "decimal_places": 1,
628                 "detail_view": {
629                   "is_hidden": true
630                 },
631                 "display_name": "string",
632                 "filter_view": {
633                   "is_hidden": true
634                 },
635                 "group_name": "string",
636                 "is_active_in_detail_view": true,
637                 "is_bulk_action_enabled": true,
638                 "is_currency_field": true,
639                 "is_groupable": true,
640                 "is_hidden": true,
641                 "is_hidden_during_create": true,
642                 "is_read_only": true,
643                 "is_required": true,
644                 "is_shown_in_summary": true,
645                 "is_sortable": true,
646                 "list_view": {
647                   "is_hidden": true
648                 },
649                 "order": 1,
650                 "placeholder": "string",
651                 "summary_view": {
652                   "is_hidden": true
653                 },
654                 "tooltip": "string",
655                 "unit": "string",
656                 "use_shorthand_notation": true
657               },
658               "default_value": true
659             },
660             "reference_name": "string",
661             "type": "custom_field",
662             "custom_field": {
663               "leaf_type": "string",
664               "name": "string",
665               "subtype": "string"
666             },
667             "has_custom_expression": true,
668             "is_derived": true,
669             "meerkat_schema": {
670               "type": "boolean",
671               "sql_expression": "string",
672               "function": {
673                 "type": "avg"
674               },
675               "timestamp_rollup": "day"
676             }
677           }
678         ],
679         "external_data_source": {
680           "id": "string",
681           "dataset_projections": [
682             {
683               "columns": [
684                 {
685                   "name": "string",
686                   "custom_field": {
687                     "leaf_type": "string",
688                     "name": "string",
689                     "subtype": "string"
690                   }
691                 }
692               ],
693               "dataset": "string"
694             }
695           ]
696         },
697         "joins": [
698           {}
699         ],
700         "measures": [
701           {
702             "devrev_schema": {
703               "description": "string",
704               "is_filterable": true,
705               "is_immutable": true,
706               "is_pii": true,
707               "is_required": true,
708               "mfz": {},
709               "name": "string",
710               "oasis": {},
711               "origin": "string",
712               "ui": {
713                 "client_overrides": [
714                   {
715                     "client_name": "string",
716                     "decimal_places": 1,
717                     "display_name": "string",
718                     "is_groupable": true,
719                     "is_hidden": true,
720                     "is_required": true,
721                     "order": 1,
722                     "placeholder": "string",
723                     "tooltip": "string",
724                     "use_shorthand_notation": true,
725                     "view_overrides": [
726                       {
727                         "decimal_places": 1,
728                         "display_name": "string",
729                         "is_groupable": true,
730                         "is_hidden": true,
731                         "is_required": true,
732                         "order": 1,
733                         "placeholder": "string",
734                         "tooltip": "string",
735                         "use_shorthand_notation": true,
736                         "view_name": "string"
737                       }
738                     ]
739                   }
740                 ],
741                 "create_view": {
742                   "is_hidden": true
743                 },
744                 "decimal_places": 1,
745                 "detail_view": {
746                   "is_hidden": true
747                 },
748                 "display_name": "string",
749                 "filter_view": {
750                   "is_hidden": true
751                 },
752                 "group_name": "string",
753                 "is_active_in_detail_view": true,
754                 "is_bulk_action_enabled": true,
755                 "is_currency_field": true,
756                 "is_groupable": true,
757                 "is_hidden": true,
758                 "is_hidden_during_create": true,
759                 "is_read_only": true,
760                 "is_required": true,
761                 "is_shown_in_summary": true,
762                 "is_sortable": true,
763                 "list_view": {
764                   "is_hidden": true
765                 },
766                 "order": 1,
767                 "placeholder": "string",
768                 "summary_view": {
769                   "is_hidden": true
770                 },
771                 "tooltip": "string",
772                 "unit": "string",
773                 "use_shorthand_notation": true
774               },
775               "default_value": true
776             },
777             "reference_name": "string",
778             "type": "custom_field",
779             "custom_field": {
780               "leaf_type": "string",
781               "name": "string",
782               "subtype": "string"
783             },
784             "has_custom_expression": true,
785             "is_derived": true,
786             "meerkat_schema": {
787               "type": "boolean",
788               "sql_expression": "string",
789               "function": {
790                 "type": "avg"
791               },
792               "timestamp_rollup": "day"
793             }
794           }
795         ],
796         "oasis": {
797           "sql_query": "string",
798           "datasets": [
799             "string"
800           ],
801           "projections": [
802             {
803               "columns": [
804                 {
805                   "name": "string",
806                   "custom_field": {
807                     "leaf_type": "string",
808                     "name": "string",
809                     "subtype": "string"
810                   }
811                 }
812               ],
813               "dataset": "string"
814             }
815           ]
816         }
817       }
818     ],
819     "display_id": "string",
820     "is_draft": true,
821     "is_system": true,
822     "modified_by": {
823       "display_id": "string",
824       "id": "string",
825       "display_name": "string",
826       "display_picture": {
827         "display_id": "string",
828         "id": "string",
829         "file": {
830           "type": "string",
831           "name": "string",
832           "size": 1
833         }
834       },
835       "email": "string",
836       "full_name": "string",
837       "state": "active"
838     },
839     "modified_date": "2023-01-01T12:00:00.000Z",
840     "name": "string"
841   }
842 }

Returns the requested widget.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringRequiredformat: "text"

The requested widget's ID.

Response

The response to a widget get request.

Authentication

Query parameters

Response

Errors