Sign inGet started
Docs
Get started

Get Analytics Page

Read a page: its settings, variables (filters), tabs, and its panels with their places on the grid. Pass version=draft to read changes not yet published; an editor's draft answer carries the revision the next change sends in If-Match (also in the ETag header).

GET

Path

Path parameters
stringrequired

The page id, from List Analytics Pages.

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. Left out, a published page answers the version viewers see.

Which version 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.

Response fields

idstring

The page id.

namestring

The page title.

descriptionstring

The line under the title, or null.

typestring

What kind of page it is.

  • pageAn ordinary page in the sidebar.
  • reportA report: one written panel that fills the page.
  • subpageA page opened from a click on another page, not listed on its own.
accessstring

What the key's creator can do on it.

  • ownerThe key's creator owns the page.
  • editShared with the creator to edit.
  • viewShared with the creator to view.
ownerIdstring

The owner's userId, from List Members.

ownerNamestring

The owner's name.

folderIdstring

The creator's folder the page is filed in (from List Analytics Folders), or null when it is unfiled or shared with them.

iconstring

The page icon id, or null.

iconColorstring

The page icon color, or null.

isPausedboolean

Whether its data stopped refreshing, by the page itself or a folder above it.

pausedByFolderIdstring

The folder that paused it (from List Analytics Folders), or null.

hasSharesboolean

Whether anyone besides the owner can open it.

linkedFromPageIdsarray of string

The pages whose clicks open this one, from List Analytics Pages.

createdOndate

When it was created.

updatedOndate

When the page or one of its panels last changed.

fullWidthboolean

Whether the page spans the whole window.

showPanelSourcesboolean

Whether each panel shows its data sources' app icons.

themeIdstring

The theme the page wears, from List Analytics Themes, or null to follow its folder or the company default.

styleobject

Style overrides on top of the theme, by option, or null.

variablesarray of objects

The page variables (its filters), in page order, in the shape Set Analytics Page Variables takes.

  • namestring

    The variable name. Queries read it as $<name>.

  • typestring

    What it holds.

    • dateRangeA date window.
    • selectOne value, or several with multiple, from a list of choices.
    • searchFree text a viewer types.
    • toggleAn on or off switch.
  • controlstring

    chip shows a picker on the page; none has no picker.

    • chip
    • none
  • labelstring

    The picker label.

  • defaultobject

    What the page opens with: a date preset or range, all or a choice value, or true or false for a toggle.

  • multipleboolean

    A select that takes several choices.

  • labeledBystring

    A select set by a row click: the clicked row field that names the value.

  • optionsobject

    A select: where its choices come from, as dataSourceId with query or valueField and labelField, or typed values.

  • presetsarray

    A dateRange: its preset menu, in order.

  • showCalendarboolean

    A dateRange: false allows presets only.

  • timeGranularityboolean

    A dateRange: custom ranges carry times.

tabsarray of objects

The page tabs in order, or empty when the page has none.

  • idstring

    The tab id.

  • namestring

    The tab name.

versionobject

Which version this answer shows and where the page stands.

  • modestring

    draft when it shows the draft, published when it shows the version viewers see.

    • draft
    • published
  • publishedVersionnumber

    The number of the version viewers see, or null when never published.

  • publishedVersionIdstring

    Its id, from List Analytics Page Versions, or null.

  • publishedOndate

    When it was published, or null.

  • hasUnpublishedChangesboolean

    Editors only: whether the draft differs from the published version. Null for viewers and never-published pages.

panelsarray of objects

The panels in this version, with where each sits, as Get Analytics Panel answers them (which answers one in full).

  • idstring

    The panel id.

  • namestring

    The panel's title, shown in its card header.

  • placementstring

    Where the panel shows.

    • pageOn the page grid.
    • drillOff the grid: it opens when a click on another panel drills into it, narrowed by the clicked row.
  • displayTypestring

    How the panel draws its rows. One of: table, bar, line, combo, pareto, bump, scatter, bubble, quadrant, pie, treemap, heatmap, pivot, cohort, statusgrid, activity, funnel, waterfall, sankey, chord, statetimeline, timeline, stat, trend, progress, gauge, bullet, report, document, workbook, html, map, region, tabs, group.

    • tableDraws a table panel.
    • barDraws a bar panel.
    • lineDraws a line panel.
    • comboDraws a combo panel.
    • paretoDraws a pareto panel.
    • bumpDraws a bump panel.
    • scatterDraws a scatter panel.
    • bubbleDraws a bubble panel.
    • quadrantDraws a quadrant panel.
    • pieDraws a pie panel.
    • treemapDraws a treemap panel.
    • heatmapDraws a heatmap panel.
    • pivotDraws a pivot panel.
    • cohortDraws a cohort panel.
    • statusgridDraws a statusgrid panel.
    • activityDraws a activity panel.
    • funnelDraws a funnel panel.
    • waterfallDraws a waterfall panel.
    • sankeyDraws a sankey panel.
    • chordDraws a chord panel.
    • statetimelineDraws a statetimeline panel.
    • timelineDraws a timeline panel.
    • statDraws a stat panel.
    • trendDraws a trend panel.
    • progressDraws a progress panel.
    • gaugeDraws a gauge panel.
    • bulletDraws a bullet panel.
    • reportDraws a report panel.
    • documentDraws a document panel.
    • workbookDraws a workbook panel.
    • htmlDraws a html panel.
    • mapDraws a map panel.
    • regionDraws a region panel.
    • tabsDraws a tabs panel.
    • groupDraws a group panel.
  • layoutobject

    The panel's place on the page grid. Null when it was never placed (it then flows full width in creation order), and for a drill-down or a panel inside a container.

    • xnumber

      Leftmost column on the 12-column grid, 0-11.

    • ynumber

      Top row, from 0.

    • wnumber

      Width in columns, 1-12.

    • hnumber

      Height in rows (one row is about 48px). Null when the panel is as tall as what it shows.

  • tabIdstring

    The page tab the panel sits on, from Get Analytics Page. Null on a page without tabs, and for a drill-down or a panel inside a container.

  • containedBystring

    The container panel (tabs or group) it renders inside, or null when it sits on the grid or is a drill-down.

revisionstring

The draft revision, when this answer shows the draft to an editor: send it in If-Match with the next change to the page. Null otherwise.