Get Analytics Panel Output

See what a panel produces: its status, any failure message, and its rows, a window at a time. Check it after Update Analytics Panel, reading the draft.

GET

Path

Path parameters

stringrequired

The page id, from List Analytics Pages.

stringrequired

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

Query

Arguments

string

draft or published.

Which version of the page to read. 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

panelIdstring

The panel, from Get Analytics Page.

statusstring

Where the panel's stored result stands.

readyRows are ready.
emptyIt ran and returned no rows.
refreshingIts sources are fetching; the result follows.
failedIt failed; message says why.
draftIt is set up but has not produced a result yet.
noResultIt has sources but no stored result yet. Set its query or transform to run it.
noDataSourceIt has no data source yet.

messagestring

Why it failed or is waiting. Null when there is nothing to say.

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.

updatedOndate

When the result was last written. Null when there is none.

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.