> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/report/api-report-widget.md).

# /api/report/widget

## GET /api/report/widget

> Get widget settings

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/report/widget"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_report_widget":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["widget"]}}},"paths":{"/api/report/widget":{"get":{"description":"Get widget settings","tags":["/api/report/widget"],"parameters":[{"name":"widget","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_report_widget"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_report_widget"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_report_widget"}}}}}}}}}
```

## PATCH /api/report/widget

> Edit report widget

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/report/widget"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_report_widget":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["widget"]}}},"paths":{"/api/report/widget":{"patch":{"description":"Edit report widget","tags":["/api/report/widget"],"parameters":[{"name":"widget","in":"query","schema":{"type":"string"},"required":true},{"name":"name","in":"query","schema":{"type":"string"},"required":false},{"name":"settings","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_report_widget"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_report_widget"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_report_widget"}}}}}}}}}
```