Get Analytics Data Source Result

Read a data source's stored rows and how its last fetch went. Poll it after Create, Update or Fetch Analytics Data Source until status is ready (or failed, with message saying why). Page through the rows with limit and offset; nextOffset is the offset of the next window, null on the last. While a first fetch is still running, the rows stored so far come back with isPartial true: their shape is final, so you can design panels on them. A live source stores no rows. For a source another member owns, send the id of a page shared with the creator that uses it.

GET

Path

Path parameters

stringrequired

The data source's id, from List Analytics Data Sources or a panel's dataSources.

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

For a source another member owns: a page shared with the key's creator that uses it, from List Analytics Pages.

For a source another member owns: the id of a page shared with the key's creator that uses it, from List Analytics Pages.

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

idstring

The data source's id.

statusstring

Where its data stands. live: a live source, which has no stored data; neverFetched: no fetch has run yet; noData: a fixed source with no rows yet; draft: waiting for its first fetch; queued: a fetch is waiting to start; refreshing: a fetch is running; ready: its rows are stored; empty: the last fetch returned no rows; failed: the last fetch failed (see message).

live
neverFetched
noData
draft
queued
refreshing
ready
empty
failed

fetchedOndate

When the stored rows were fetched.

messagestring

Why the last fetch failed, when it did.

isTruncatedboolean

True when the fetch stopped at a size limit, so the stored rows are not the whole set.

isPartialboolean

True while a first fetch is still running: these are the rows stored so far, and their shape is final.

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.