putInsight

Replace an insight's content by ID. Sharing is managed via patchInsight.

Request body

created_bystring

Id of the user who created the resource

created_atstring date-time

updated_bystring

Id of the user who last updated the resource

updated_atstring date-time

owner_org_idstring

Id of the organisation that owns the resource. Set at creation time and immutable.

ownersstring[]

User ids with full control over the resource (view, edit, delete and manage sharing). The creator is always an owner. There must always be at least one owner.

idstring uuid

Unique identifier for an insight (a saved chart / visualisation)

namestring required

Human readable name of the insight

descriptionstring

Unique identifier for a Visualisation

tagsstring[]

Free-form labels for grouping and filtering insights

Example request

{
  "created_by": "10598",
  "updated_by": "10598",
  "owner_org_id": "739224",
  "owners": [
    "10598"
  ],
  "shared_with": [
    {
      "user_id": "10598",
      "permission": "view"
    }
  ],
  "id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
  "name": "Opportunities created by journeys every month",
  "description": "Monthly count of opportunities grouped by source journey",
  "visualisation_id": "timechart",
  "visualisation_config": {
    "query": {
      "dataset": "entity_operations",
      "measure": "count_operations",
      "dimensions": [
        {
          "time_with_granularity": "year-month"
        }
      ],
      "filters": [
        {
          "entity_schema": "opportunity"
        }
      ]
    },
    "options": {
      "type": "bar"
    }
  },
  "tags": [
    "revenue",
    "marketing"
  ]
}

Response

The insight with the passed ID