Update Widget

PATCH /widgets/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/widgets/{id}

Updates the specific Widget by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Request Body Schema
Arrow
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.


Example: 1001
confobject
The configuration of the widget. It is an arbitrary key-value pair object, where key must be a string, and value can be of any type.
descriptionstring
The detailed dashboard description. Minimum length 5. Maximum length 1000.


Example: Displays top 10 users with most activities
dsobject
widget configuration.
gridobject
widget cordinates.
namestring
The widget name. Minimum length 1. Maximum length 100.


Example: Top 10
refstring
Ref field is related only with system widgets.


Example: w1
systeminteger
Indicates whether the widget is system or user defined. Note that system widgets can't be deleted or modified.


Example: 1

Possible values: 1 | 0
typestring
The type of the widget.


Example: timeline

Possible values: metric | table | timeline
Response status codes
Arrow
204 - No Content
Arrow

warning
1 Changes will be applied on all dashboards associated with this widget.
note
1 System widget can't be modified.
tip
1 If you don't know the widget id, list the widgets to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "Top 10",
  "description": "Displays top 10 users with most activities",
  "conf": {
    "metric": {
        "sparkline": true
    }
  },
  "ds": {
    "fields": "cir,click,conversion,cpc",
    "filter": null,
    "resolution": null,
    "source": "adex.advertiser",
    "timeshift": null
  }
}