Skip to main content

Objects

CounterResponse

The counter response object. It contains a single Metric value for the given time range and Query Filters.

Fields

  • value nullable String

    The value of the counter.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

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.

Learn more about pagination in GraphQL.

Fields

  • headers non-null array of String

    The Data Grid table's headers.

  • rows non-null array of String

    An array of arrays containing the values of the Data Grid table's rows.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

  • pageInfo non-null PageInfo

    The Data Grid table's page info.

    The page info object used for pagination.

    • pageInfo.startCursor nullable String

      Points to the first item returned in the results. Used when paginating backward.

    • pageInfo.endCursor nullable String

      Points to the last item returned in the results. Used when paginating forward.

    • pageInfo.hasNextPage non-null Boolean

      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.

    • pageInfo.hasPreviousPage non-null Boolean

      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.

  • edges non-null array of DataGridEdge

    The Data Grid table's edges.

    The Data Grid edge object.

    Learn more about pagination in GraphQL.

  • nodes non-null array of DataGridNode

    The Data Grid table's nodes.

    The Data Grid table's node.

    This type represents a single row of a Data Grid table.

    Learn more about pagination in GraphQL.

    • nodes.headers non-null array of String

      The Data Grid table's headers.

    • nodes.row non-null array of String

      An array of the values for the row.

DataGridEdge

The Data Grid edge object.

Learn more about pagination in GraphQL.

Fields

  • node non-null DataGridNode

    The edge's node.

    The Data Grid table's node.

    This type represents a single row of a Data Grid table.

    Learn more about pagination in GraphQL.

    • node.headers non-null array of String

      The Data Grid table's headers.

    • node.row non-null array of String

      An array of the values for the row.

  • cursor non-null String

    The edge's cursor.

DataGridNode

The Data Grid table's node.

This type represents a single row of a Data Grid table.

Learn more about pagination in GraphQL.

Fields

  • headers non-null array of String

    The Data Grid table's headers.

  • row non-null array of String

    An array of the values for the row.

DescribeSqlResponse

Response from the describe SQL API.

Fields

  • columns non-null array of SqlColumnResponse

    The columns that the query would return.

    • columns.columnName non-null String

      The name of the returned column.

    • columns.type non-null ColumnType

      The returned column's type.

      The Propel data types.

      • BOOLEAN

        True or false.

      • STRING

        A variable-length string.

      • FLOAT

        A 32-bit signed double-precision floating point number.

      • DOUBLE

        A 64-bit signed double-precision floating point number.

      • INT8

        An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

      • INT16

        A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

      • INT32

        A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

      • INT64

        A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

      • DATE

        A date without a timestamp. For example, "YYYY-MM-DD".

      • TIMESTAMP

        A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

      • JSON

        A JavaScript Object Notation (JSON) document.

      • CLICKHOUSE

        A ClickHouse-specific type.

    • columns.isNullable non-null Boolean

      Whether the column is nullable, meaning whether it accepts a null value.

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.

Fields

  • headers non-null array of String

    The table headers. It contains the Dimension and Metric names.

  • rows non-null array of String

    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.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

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.

Learn more about pagination in GraphQL.

Fields

  • pageInfo non-null PageInfo

    The report connection's page info.

    The page info object used for pagination.

    • pageInfo.startCursor nullable String

      Points to the first item returned in the results. Used when paginating backward.

    • pageInfo.endCursor nullable String

      Points to the last item returned in the results. Used when paginating forward.

    • pageInfo.hasNextPage non-null Boolean

      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.

    • pageInfo.hasPreviousPage non-null Boolean

      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.

  • edges non-null array of MetricReportEdge

    The report connection's edges.

    The Metric Report edge object.

    Learn more about pagination in GraphQL.

  • nodes non-null array of MetricReportNode

    The report connection's nodes.

    The Metric Report node object.

    This type represents a single row of a report.

    Learn more about pagination in GraphQL.

    • nodes.headers non-null array of String

      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.

    • nodes.row non-null array of String

      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.

  • headers non-null array of String

    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.

  • rows non-null array of String

    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.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

MetricReportEdge

The Metric Report edge object.

Learn more about pagination in GraphQL.

Fields

  • node non-null MetricReportNode

    The edge's node.

    The Metric Report node object.

    This type represents a single row of a report.

    Learn more about pagination in GraphQL.

    • node.headers non-null array of String

      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.

    • node.row non-null array of String

      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.

  • cursor non-null String

    The edge's cursor.

MetricReportNode

The Metric Report node object.

This type represents a single row of a report.

Learn more about pagination in GraphQL.

Fields

  • headers non-null array of String

    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.

  • row non-null array of String

    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.

PageInfo

The page info object used for pagination.

Fields

  • startCursor nullable String

    Points to the first item returned in the results. Used when paginating backward.

  • endCursor nullable String

    Points to the last item returned in the results. Used when paginating forward.

  • hasNextPage non-null Boolean

    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.

  • hasPreviousPage non-null Boolean

    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.

QueryInfo

The Query Info object. It contains metadata and statistics about a Query performed.

Fields

  • id non-null ID

    The Query's unique identifier.

  • createdAt non-null DateTime

    The date and time in UTC when the Query was created.

  • createdBy non-null String

    The unique identifier of the actor that performed the Query.

  • modifiedAt non-null DateTime

    The date and time in UTC when the Query was last modified.

  • modifiedBy non-null String

    The unique identifier of the actor that modified the Query.

  • bytesProcessed non-null String

    The bytes processed by the Query.

  • durationInMilliseconds non-null Int

    The duration of the Query in milliseconds.

  • recordsProcessed non-null String

    The number of records processed by the Query.

  • resultingBytes non-null Int

    The bytes returned by the Query.

  • resultingRecords non-null Int

    The number of records returned by the Query.

  • propeller nullable Propeller

    The Propeller used for this query.

    A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

    Learn more about Data Sources.

    • P1_X_SMALL

      Max records per second: 5,000,000 records per second

    • P1_SMALL

      Max records per second: 25,000,000 records per second

    • P1_MEDIUM

      Max records per second: 100,000,000 records per second

    • P1_LARGE

      Max records per second: 250,000,000 records per second

    • P1_X_LARGE

      Max records per second: 500,000,000 records per second

  • status non-null QueryStatus

    The Query status.

    The Query status.

    • COMPLETED

      The Query was completed succesfully.

    • ERROR

      The Query experienced an error.

    • TIMED_OUT

      The Query timed out.

  • type non-null QueryType

    The Query type.

    The Query type.

    • METRIC

      Indicates a Metric Query.

    • STATS

      Indicates a Dimension Stats Query.

    • REPORT

      Indicates a Report Query.

    • RECORDS

      Indicates a Record Table Query.

    • RECORDS_BY_UNIQUE_ID

      Indicates records queried by unique ID.

    • SELECT

      Indicates a SelectV1 Query.

    • SQL

      Indicates a SQL Query.

    • TOP_VALUES

      Indicates a Top Values Query.

  • subtype nullable QuerySubtype

    The Query subtype.

    The Query subtype.

    • COUNTER

      Indicates a Metric counter Query.

    • TIME_SERIES

      Indicates a Metric time series Query.

    • LEADERBOARD

      Indicates a Metric leaderboard Query.

RecordsByUniqueIdResponse

Fields

  • columns non-null array of String

    The Data Pool columns for the record.

  • values non-null array of String

    An array of values for the record.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

SqlColumnResponse

Fields

  • columnName non-null String

    The name of the returned column.

  • type non-null ColumnType

    The returned column's type.

    The Propel data types.

    • BOOLEAN

      True or false.

    • STRING

      A variable-length string.

    • FLOAT

      A 32-bit signed double-precision floating point number.

    • DOUBLE

      A 64-bit signed double-precision floating point number.

    • INT8

      An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

    • INT16

      A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

    • INT32

      A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

    • INT64

      A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

    • DATE

      A date without a timestamp. For example, "YYYY-MM-DD".

    • TIMESTAMP

      A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

    • JSON

      A JavaScript Object Notation (JSON) document.

    • CLICKHOUSE

      A ClickHouse-specific type.

  • isNullable non-null Boolean

    Whether the column is nullable, meaning whether it accepts a null value.

SqlResponse

Response from the SQL API.

Fields

  • columns non-null array of SqlColumnResponse

    The column names in the same order as present in the data field.

    • columns.columnName non-null String

      The name of the returned column.

    • columns.type non-null ColumnType

      The returned column's type.

      The Propel data types.

      • BOOLEAN

        True or false.

      • STRING

        A variable-length string.

      • FLOAT

        A 32-bit signed double-precision floating point number.

      • DOUBLE

        A 64-bit signed double-precision floating point number.

      • INT8

        An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

      • INT16

        A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

      • INT32

        A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

      • INT64

        A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

      • DATE

        A date without a timestamp. For example, "YYYY-MM-DD".

      • TIMESTAMP

        A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

      • JSON

        A JavaScript Object Notation (JSON) document.

      • CLICKHOUSE

        A ClickHouse-specific type.

    • columns.isNullable non-null Boolean

      Whether the column is nullable, meaning whether it accepts a null value.

  • rows non-null array of String

    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.

  • info non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • info.id non-null ID

      The Query's unique identifier.

    • info.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • info.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • info.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • info.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • info.bytesProcessed non-null String

      The bytes processed by the Query.

    • info.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • info.recordsProcessed non-null String

      The number of records processed by the Query.

    • info.resultingBytes non-null Int

      The bytes returned by the Query.

    • info.resultingRecords non-null Int

      The number of records returned by the Query.

    • info.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • info.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • info.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • info.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

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.

Fields

  • labels non-null array of String

    The time series labels.

  • values non-null array of String

    The time series values.

  • groups nullable array of TimeSeriesResponseGroup

    The time series values for each group in groupBy, if specified.

    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.

    • groups.group non-null array of String

      The time series group's columns.

    • groups.labels non-null array of String

      The time series group's labels.

    • groups.values non-null array of String

      The time series group's values.

  • query non-null QueryInfo

    The Query statistics and metadata.

    The Query Info object. It contains metadata and statistics about a Query performed.

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

      The date and time in UTC when the Query was created.

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

      The date and time in UTC when the Query was last modified.

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

      • REPORT

        Indicates a Report Query.

      • RECORDS

        Indicates a Record Table Query.

      • RECORDS_BY_UNIQUE_ID

        Indicates records queried by unique ID.

      • SELECT

        Indicates a SelectV1 Query.

      • SQL

        Indicates a SQL Query.

      • TOP_VALUES

        Indicates a Top Values Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.

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.

Fields

  • group non-null array of String

    The time series group's columns.

  • labels non-null array of String

    The time series group's labels.

  • values non-null array of String

    The time series group's values.

TopValuesResponse

Fields

  • values non-null array of String

    An array with the list of values.