Update Custom Report

patchhttps://d1iwal3igywepk.cloudfront.net/custom-reports/{id}

Retitles a custom report, pins or unpins it as a sidebar tab (pinned), sets its sidebar rank (sidebar_position, 0 = first tab), or reorders its blocks (order). To change the blocks themselves, use the block endpoints.

Authorization

AuthorizationBearer <token>

API key as Bearer token

In: header

Path Parameters

id*string

Request Body

application/json

title?string

description?string|null

pinned?boolean

sidebar_position?integer

order?array<string>

Block ids in the new display order; ids left out keep their relative order after these.

filters?array<>

Replaces the custom report's filter list whole; [] removes them all; omit to keep it.

Itemsitems <= 6

Responses

Updated

id*string

Formatuuid

title*string

description*string|null

source*string

Value in

"agent"
"app"

url*string

The page on app.fullvision.io

pinned*boolean

Shown as a sidebar tab

sidebar_position*integer|null

updated_at*string

filters*array<>

Viewer filter controls shown above the page's charts, in order.

blocks*array<>

patch/custom-reports/{id}

curl -X PATCH "https://d1iwal3igywepk.cloudfront.net/custom-reports/string" \  -H "Content-Type: application/json" \  -d '{}'

Example Request Body

json

{}

Example Responses

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "title": "string",  "description": "string",  "source": "agent",  "url": "string",  "pinned": true,  "sidebar_position": 0,  "updated_at": "string",  "filters": [    {      "key": "date_range",      "default": {        "range": "last_30_days"      }    }  ],  "blocks": [    {      "id": "b3280abc24d7",      "kind": "string",      "size": "small",      "source": "agent",      "layout": {        "x": 0,        "y": 0,        "w": 0,        "h": 0      },      "chart": {        "source": "report",        "report": "channel-report",        "title": "Revenue by channel",        "viz": "line",        "metric": "total_cash_cents",        "metric_x": "string",        "columns": [          "string"        ],        "block": "devices",        "params": {          "range": "last_90_days",          "order_by": "total_cash_cents",          "limit": 10        }      },      "filters": [        {          "key": "date_range",          "default": {            "range": "last_30_days"          }        }      ]    }  ]}

application/json