GetSupportQuery

POST

https://api.cbf.tcn.com/api/v1alpha1/explorer/explorer/getsupportquery

ExplorerService

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

SupportQueryRequest is the request to query a datasource with support permissions.

query_request

optional

query_request is the query to execute.

One of

pipeline

prql

allOf {2}

datasource_type

enum<string>

DatasourceType

optional

DatasourceType is an enum for the type of a datasource.

Allowed values:

DATASOURCE_TYPE_UNSPECIFIEDDATASOURCE_TYPE_VFSDATASOURCE_TYPE_CLICKHOUSEDATASOURCE_TYPE_INSTANT_DATA

start_time

string <date-time>

google.protobuf.Timestamp

optional

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

1s1.000340012s

end_time

string <date-time>

google.protobuf.Timestamp

optional

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

Examples:

1s1.000340012s

pipeline_parameters

object

Parameters

optional

Parameter is a parameter for a query.

format

enum<string>

ExportFormat

optional

ExportFormat is an enum for the format of a report.

Allowed values:

REPORT_FORMAT_UNSPECIFIEDREPORT_FORMAT_CSVREPORT_FORMAT_PARQUETREPORT_FORMAT_TSVREPORT_FORMAT_TXT

time_period

enum<string>

TimePeriod

optional

TimePeriodEnum is an enumeration of time period filters.

Allowed values:

TIME_PERIOD_UNSPECIFIEDTIME_PERIOD_TODAYTIME_PERIOD_THIS_WEEKTIME_PERIOD_THIS_MONTHTIME_PERIOD_THIS_YEARTIME_PERIOD_THE_DAY_SO_FARTIME_PERIOD_WEEK_TO_DATETIME_PERIOD_MONTH_TO_DATETIME_PERIOD_YEAR_TO_DATETIME_PERIOD_YESTERDAYTIME_PERIOD_DAY_BEFORE_YESTERDAYTIME_PERIOD_THIS_DAY_LAST_WEEKTIME_PERIOD_PREVIOUS_WEEKTIME_PERIOD_PREVIOUS_MONTHTIME_PERIOD_PREVIOUS_YEARTIME_PERIOD_LAST_15_MINUTESTIME_PERIOD_LAST_30_MINUTESTIME_PERIOD_LAST_1_HOURTIME_PERIOD_LAST_2_HOURSTIME_PERIOD_LAST_3_HOURSTIME_PERIOD_LAST_4_HOURSTIME_PERIOD_LAST_6_HOURSTIME_PERIOD_LAST_12_HOURSTIME_PERIOD_LAST_24_HOURSTIME_PERIOD_LAST_2_DAYSTIME_PERIOD_LAST_3_DAYSTIME_PERIOD_LAST_7_DAYSTIME_PERIOD_LAST_2_WEEKSTIME_PERIOD_LAST_30_DAYSTIME_PERIOD_LAST_60_DAYSTIME_PERIOD_LAST_90_DAYSTIME_PERIOD_LAST_6_MONTHSTIME_PERIOD_LAST_1_YEARTIME_PERIOD_LAST_2_YEARSTIME_PERIOD_LAST_5_YEARS

report_date

string <date-time>

google.protobuf.Timestamp

optional

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

Examples:

1s1.000340012s

export_options

object

ExportOptions

optional

Message for Export Options

datasource_name

string

datasource_name

optional

datasource_name is the name of the datasource to query.

timezone

string

timezone

optional

timezone is IESG timezone name
this is how the timezone is represented in the query

ui_trace_id

string

ui_trace_id

optional

ui_trace_id is the trace id of the query.

comment

string

comment

optional

comment is the comment for the query.

result_types

array[string]

result_types

optional

result types for the query
raw result type always included

Allowed values:

RESULT_TYPE_UNSPECIFIEDRESULT_TYPE_FORMATRESULT_TYPE_SUMMARYRESULT_TYPE_REPORT

org_ids

array[string]

org_ids

optional

org_id for ownership of the data

pipeline

string

pipeline

required

pipeline to be compiled to prql

debug

boolean

debug

optional

include debug information in the response

Example

{
  "query_request": {
    "pipeline": "string"
  },
  "debug": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/explorer/explorer/getsupportquery' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query_request": {
        "pipeline": "string"
    },
    "debug": true
}'

Responses

🟢200OK

application/json

Success

Body

SupportQueryResponse contains the result of a datasource query with support permissions.

result_url

string

result_url

optional

result_url is the URL to the result of the query.

prql

string

prql

optional

the prql query string

sql

string

sql

optional

the sql query string

explain

string

explain

optional

the sql explain string

post_processing_table_query

string

post_processing_table_query

optional

post processing query

post_processing_summary_query

string

post_processing_summary_query

optional

post processing summary query

result_urls

object

result_urls

optional

result urls per result type
raw result type always included
the key is the enum value of ResultType

Additional properties

object (ResultFile)

value

optional

Represents a result file, including its URL and size in bytes.

result_size_bytes

integer <int64> | string

result_size_bytes

optional

result_size_bytes is the size of the result in bytes.

time_filtered_datasources

object

time_filtered_datasources

optional

map of datasources and a boolean indicating if the datasource is filtered by time

Additional properties

boolean

value

optional

Example

{
  "result_url": "string",
  "prql": "string",
  "sql": "string",
  "explain": "string",
  "post_processing_table_query": "string",
  "post_processing_summary_query": "string",
  "result_urls": {
    "property1": {
      "url": "string",
      "size_bytes": 0
    },
    "property2": {
      "url": "string",
      "size_bytes": 0
    }
  },
  "result_size_bytes": 0,
  "time_filtered_datasources": {
    "property1": true,
    "property2": true
  }
}

🔴500Server Error

Query

GetQueryExplain