Get Widget (POST)

POST

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

POST

/widgets.get

1 curl -X POST https://api.devrev.ai/widgets.get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "id": "foo"
6 }'

Try it

200widgetsGetPostExample

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

Returns the requested widget.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

idstringRequiredformat: "text"

The requested widget's ID.

Response

The response to a widget get request.

Headers

Request

Response

Errors