Create Custom Report

posthttps://d1iwal3igywepk.cloudfront.net/custom-reports

Creates a custom report from a title, an optional description, and a list of blocks. Each block has a title, a viz and a request: the report to call and its params, exactly as you would pass them to that report's endpoint. The custom report re-runs every request on each view, so pass a rolling range (last_30_days, 90d...) for numbers that stay current, or fixed from/to for a period that should not move.

Set pinned: true to add the custom report as a tab in the app sidebar for everyone in the workspace. A custom report holds at most 24 blocks, and a key can only request reports it is allowed to read. The response carries the custom report's url on app.fullvision.io.

Authorization

AuthorizationBearer <token>

API key as Bearer token

In: header

Request Body

application/json

title*string

description?string

pinned?boolean

blocks?array<|>

filters?array<>

Viewer filter controls shown above the custom report's charts, in order. Each applies to every chart whose report accepts it.

Itemsitems <= 6

Responses

Created

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<>

post/custom-reports

curl -X POST "https://d1iwal3igywepk.cloudfront.net/custom-reports" \  -H "Content-Type: application/json" \  -d '{    "title": "Acme — acquisition"  }'

Example Request Body

json

{  "title": "Acme — acquisition"}

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