get-query-info

Get query info for a chart, dashboard, or report. Returns query status, SQL, malloy and data.

Request Body

application/json

projectId*string

Project ID

repoId*string

Repository ID

branchId*string

Git branch name

envId*string

Environment ID

chartId?|

Chart ID to get query info for. Omit if querying a dashboard or report.

dashboardId?|

Dashboard ID to get query info for. Omit if querying a chart or report.

tileIndex?|

Dashboard tile index. Omit to get all tiles.

reportId?|

Report ID to get query info for. Omit if querying a chart or dashboard.

rowId?|

Report row ID. Omit to get all rows.

timezone*string

Timezone, e.g. "UTC"

timeSpec?|

Time specification for the query. Omit to use default time range.

timeRangeFractionBrick?|

Time range fraction brick. Omit to use default.

getMalloy*boolean

Include Malloy query in output

getSql*boolean

Include SQL query in output

getData*boolean

Include query data in output

isFetch*boolean

Fetch latest data from the database

Response Body

`application/json`

Input

{
  "projectId": "string",
  "repoId": "string",
  "branchId": "string",
  "envId": "string",
  "chartId": "string",
  "dashboardId": "string",
  "tileIndex": 0,
  "reportId": "string",
  "rowId": "string",
  "timezone": "string",
  "timeSpec": "string",
  "timeRangeFractionBrick": "string",
  "getMalloy": true,
  "getSql": true,
  "getData": true,
  "isFetch": true
}

Output

{
  "chart": {
    "title": "string",
    "chartId": "string",
    "url": "string",
    "query": {
      "connectionId": "string",
      "connectionType": "PostgreSQL",
      "queryId": "string",
      "status": "New",
      "lastRunBy": "string",
      "lastRunTs": 0,
      "lastCancelTs": 0,
      "lastCompleteTs": 0,
      "lastCompleteDuration": 0,
      "lastErrorMessage": "string",
      "lastErrorTs": 0,
      "data": {},
      "malloy": "string",
      "sql": "string"
    }
  },
  "dashboard": {
    "title": "string",
    "dashboardId": "string",
    "url": "string",
    "tiles": [
      {
        "title": "string",
        "query": {}
      }
    ]
  },
  "report": {
    "title": "string",
    "reportId": "string",
    "url": "string",
    "rows": [
      {
        "rowId": "string",
        "name": "string",
        "rowType": "empty",
        "metricId": "string",
        "formula": "string",
        "parameters": [
          {
            "apply_to": "string",
            "listen": "string",
            "fractions": [
              {
                "controls": [
                  {
                    "options": [
                      {
                        "value": "string",
                        "label": "string"
                      }
                    ],
                    "value": {},
                    "label": "string",
                    "required": "string",
                    "name": "string",
                    "controlClass": "list_input",
                    "isMetricsDate": true
                  }
                ],
                "brick": "string",
                "parentBrick": "string",
                "operator": "Or",
                "logicGroup": "OR",
                "type": "StoreFraction",
                "storeFractionSubTypeOptions": [
                  {
                    "logicGroup": "OR",
                    "typeValue": "string",
                    "value": "string",
                    "label": "string"
                  }
                ],
                "storeFractionSubType": "string",
                "storeFractionSubTypeLabel": "string",
                "storeFractionLogicGroupWithSubType": "string",
                "meta": {},
                "storeResult": "string",
                "stringValue": "string",
                "numberValue1": 0,
                "numberValue2": 0,
                "numberValues": "string",
                "numberBetweenOption": "Inclusive",
                "yesnoValue": "Yes",
                "dayOfWeekValue": "Monday",
                "dayOfWeekIndexValues": "string",
                "monthNameValue": "January",
                "quarterOfYearValue": "q1",
                "tsDateYear": 0,
                "tsDateQuarter": 0,
                "tsDateMonth": 0,
                "tsDateDay": 0,
                "tsDateHour": 0,
                "tsDateMinute": 0,
                "tsDateToYear": 0,
                "tsDateToQuarter": 0,
                "tsDateToMonth": 0,
                "tsDateToDay": 0,
                "tsDateToHour": 0,
                "tsDateToMinute": 0,
                "tsForValue": 0,
                "tsForUnit": "seconds",
                "tsLastValue": 0,
                "tsLastUnit": "seconds",
                "tsLastCompleteOption": "CompleteWithCurrent",
                "tsNextValue": 0,
                "tsNextUnit": "seconds",
                "tsMoment": {},
                "tsMomentType": "Literal",
                "tsMomentUnit": "second",
                "tsTimestampValue": "string",
                "tsMomentAgoFromNowQuantity": 0,
                "tsFromMoment": {},
                "tsFromMomentType": "Literal",
                "tsFromMomentUnit": "second",
                "tsFromTimestampValue": "string",
                "tsFromMomentAgoFromNowQuantity": 0,
                "tsToMoment": {},
                "tsToMomentType": "Literal",
                "tsToMomentUnit": "second",
                "tsToTimestampValue": "string",
                "tsToMomentAgoFromNowQuantity": 0
              }
            ]
          }
        ],
        "query": {},
        "records": [
          {}
        ]
      }
    ]
  }
}

get-model

Get a model definition including its fields, dimensions, measures, and access info

get-sample

Fetch sample data rows from a database table or column for a project connection

Request Body

Response Body

200application/json

Input

Output

On this page

`application/json`