...
Connection HTTP Interface via http://www.example.org/api/connection/visualisation.
REST HTTP Interface via http://www.example.org/api/v2/visualisation.
SCHEMA
Name | Description |
---|---|
_id | The id of this visualisation. |
description | The name of this visualisation. |
createdAt | When this visualisation was created. |
updatedAt | When this visualisation was last updated. |
type | The type of this visualisation. |
axesgroup | What to group the visualisation data points as. |
axesxLabel | The x axes label. |
axesyLabel | The y axes label. |
axesxValue | A stringified json encode object of the x axes value options. |
axesyValue | A stringified json encode object of the y axes value options. |
axesvalue | A stringified json encode object of the value for this visualisation. |
axesyOperator | The y axes operator, eg uniqueCount. |
axesxOperator | The x axes operator, eg uniqueCount. |
axesOperator | The visualisation operator, eg uniqueCount. |
axesquery | Query for this visualisation. |
axesxQuery | Query for the x axes. |
axesyQuery | Query for the y axes. |
stacked | If this visualisation is stacked. |
chart | The type of visualisation. |
filter | An array of stringified mongo filters. |
journey | The journey’s id if this visualisation is a journey. |
organisation | The organisation this visualisation belongs to. |
owner | The id of the user who created this visualisation. |
previewPeriod | The time range which is shown in this visualisation. |
isPublic | If false then this visualisation is only available to the owner and users with org/all/visualisation/view scope, otherwise it’s available to everyone in the organisation with permission. |
EXAMPLE MODEL
Code Block |
---|
{ "_id" : "59c1087dfd869741959c5701", "createdAt" : "2017-09-19T13:13:09.312Z", "updatedAt" : "2017-09-19T13:22:00.404Z", "owner" : "59c1087dfd869741959c5702", "axes" : "{}", "organisation" : "59c1087dfd869741959c5703", "isPublic" : false, "previewPeriod" : "LAST_7_DAYS", "filters" : [ "{\"color\":\"#1e8bc3\"}" ], "chart" : "LINE", "stacked" : true, "axesoperator" : "uniqueCount", "axesvalue" : "{\"optionKey\":\"statements\",\"searchString\":\"Statements\"}", "type" : "COUNTER", "description" : "Example Visualisation" } |
...