Preview Analytics Panel Drill-Down

See what a drill-down panel shows for one click: pass the clicked row's values its SQL reads as $params.

POST

Path

Path parameters

stringrequired

The page id, from List Analytics Pages.

stringrequired

The drill-down panel id, from Get Analytics Page.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

objectrequired

The clicked row's values.

The clicked row's values the panel's SQL reads as $params, keyed by param: { "userId": "u_81Kq2" }.

object

Page variable values.

Page variable values to run it under, keyed by variable. Left out, the page's defaults apply.

string

draft or published.

Which version of the page to run. Left out: the published version when there is one, otherwise the draft.

draftThe draft, with the changes not yet published. Editors and owners only.
publishedThe version viewers see.

number

How many rows to answer, 1-1000.

How many rows to answer, 1-1000. Defaults to 100.

Default: 100

number

How many rows to skip.

How many rows to skip. Defaults to 0.

Default: 0

Response fields

statusstring

How the drill-down view came out.

readyIt ran and has rows.
emptyIt ran and returned no rows.
failedIt did not run; message says why.
pendingIt is taking longer than usual; try again.

messagestring

Why the view failed or is waiting. Null when it ran.

columnsarray of string

The column names the rows carry, in order.

rowsarray of objects

The rows in this window, as objects keyed by column.

rowCountnumber

How many rows there are in all.

offsetnumber

Where this window starts.

nextOffsetnumber

The offset of the next window, or null when this is the last.

versionobject

Which version of the page this answer reads.

modestring
draft or published.
- draftThe draft, with changes not yet published.
- publishedThe version viewers see.
publishedVersionIdstring
The published version read, from List Analytics Page Versions, or null when the draft is read.