Types
Object types in the Query API
PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
MetricReportConnection
The Metric Report connection object.
It includes headers and rows for a single page of a report. It also allows paging forward and backward to other
pages of the report.
The report connection’s page info.
The report connection’s edges.
The report connection’s nodes.
An ordered array of display names for your dimensions and Metrics, as defined in the report input. Use this to display your table’s header.
An ordered array of rows. Each row contains dimension and Metric values, as defined in the report input. Use these to display the rows of your table.
The Query statistics and metadata.
MetricReportEdge
The Metric Report edge object.
The edge’s node.
The edge’s cursor.
MetricReportNode
The Metric Report node object.
This type represents a single row of a report.
An ordered array of display names for your dimensions and Metrics, as defined in the report input. Use this to display your table’s header.
An ordered array of columns. Each column contains the dimension and Metric values for a single row, as defined in the report input. Use this to display a single row within your table.
TimeSeriesResponse
The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.
The time series labels.
The time series values.
The time series values for each group in groupBy, if specified.
The Query statistics and metadata.
TimeSeriesResponseGroup
The time series response object for a group specified in groupBy. It contains an array of time series labels and an array of Metric values for a particular group.
The time series group’s columns.
The time series group’s labels.
The time series group’s values.
CounterResponse
The counter response object. It contains a single Metric value for the given time range and Query Filters.
The value of the counter.
The Query statistics and metadata.
LeaderboardResponse
The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.
The table headers. It contains the Dimension and Metric names.
An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.
The Query statistics and metadata.
QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Propeller used for this query.
The Query status.
The Query type.
The Query subtype.
The SQL the query executed.
SqlColumnResponse
The name of the returned column.
The returned column’s type.
Whether the column is nullable, meaning whether it accepts a null value.
SqlResponse
Response from the SQL API.
The column names in the same order as present in the data field.
The data gathered by the SQL query. The data is returned in an N x M matrix format, where the first dimension are the rows retrieved, and the second dimension are the columns. Each cell can be either a string or null, and the string can represent a number, text, date or boolean value.
The Query statistics and metadata.
DescribeSqlResponse
Response from the describe SQL API.
The columns that the query would return.
DataGridConnection
The Data Grid connection.
It includes headers and rows for a single page of a Data Grid table. It also allows paging forward and backward to other
pages of the Data Grid table.
The Data Grid table’s headers.
An array of arrays containing the values of the Data Grid table’s rows.
The Query statistics and metadata.
The Data Grid table’s page info.
The Data Grid table’s edges.
The Data Grid table’s nodes.
DataGridEdge
The Data Grid edge object.
The edge’s node.
The edge’s cursor.
DataGridNode
The Data Grid table’s node.
This type represents a single row of a Data Grid table.
The Data Grid table’s headers.
An array of the values for the row.
RecordsByUniqueIdResponse
The Data Pool columns for the record.
An array of values for the record.
The Query statistics and metadata.
TopValuesResponse
An array with the list of values.
Build a report, or table, consisting of multiple Metrics broken down by one-or-more dimensions.
The first few columns of the report are the dimensions you choose to break down by. The subsequent columns are the
Metrics you choose to query. By default, the report sorts on the first Metric in descending order, but you can
configure this with the orderByMetric and sort inputs.
Finally, reports use cursor-based pagination. You can control page size with the first and
last inputs.
Arguments
Returns the individual records of a Data Pool with the convenience of built-in pagination, filtering, and sorting.
Arguments
Returns an array of the most frequent values in a given column. The resulting array is sorted in descending order of approximate frequency of values.