Get apiv1projects aiagents artifacts versions viz query

GET /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/viz-query

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "metadata": {
      "description": "<string>",
      "title": "<string>"
    },
    "query": {
      "resolvedTimezone": "<string>",
      "usedParametersValues": {},
      "parameterReferences": [
        "<string>"
      ],
      "cacheMetadata": {
        "cacheHit": true,
        "preAggregate": {
          "hit": true,
          "reason": {},
          "name": "<string>"
        },
        "cacheKey": "<string>",
        "cacheExpiresAt": "2023-11-07T05:31:56Z",
        "cacheUpdatedTime": "2023-11-07T05:31:56Z"
      },
      "queryUuid": "<string>",
      "warnings": [
        {
          "message": "<string>",
          "tables": [
            "<string>"
          ],
          "fields": [
            "<string>"
          ]
        }
      ],
      "fields": {},
      "metricQuery": {
        "tableCalculations": [
          {
            "displayName": "<string>",
            "name": "<string>",
            "sql": "<string>",
            "format": {
              "round": 123,
              "currency": "<string>",
              "prefix": "<string>",
              "suffix": "<string>",
              "custom": "<string>"
            },
            "index": 123
          }
        ],
        "limit": 123,
        "sorts": [
          {
            "descending": true,
            "fieldId": "<string>",
            "pivotValues": [
              {
                "value": "<string>",
                "reference": "<string>"
              }
            ],
            "nullsFirst": true
          }
        ],
        "filters": {
          "tableCalculations": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          },
          "metrics": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          },
          "dimensions": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          }
        },
        "metrics": [
          "<string>"
        ],
        "dimensions": [
          "<string>"
        ],
        "exploreName": "<string>",
        "metadata": {
          "hasADateDimension": {
            "name": "<string>",
            "label": "<string>",
            "table": "<string>"
          }
        },
        "pivotDimensions": [
          "<string>"
        ],
        "timezone": "<string>",
        "dimensionOverrides": {},
        "metricOverrides": {},
        "customDimensions": [
          {
            "id": "<string>",
            "name": "<string>",
            "table": "<string>",
            "dimensionId": "<string>",
            "binNumber": 123
          }
        ],
        "additionalMetrics": [
          {
            "sql": "<string>",
            "table": "<string>",
            "name": "<string>",
            "label": "<string>",
            "description": "<string>",
            "hidden": true,
            "round": 123,
            "index": 123,
            "filters": [
              {
                "id": "<string>",
                "target": {
                  "fieldRef": "<string>"
                },
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "baseDimensionName": "<string>",
            "uuid": "<string>",
            "percentile": 123,
            "distinctKeys": [
              "<string>"
            ],
            "formatOptions": {
              "round": 123,
              "currency": "<string>",
              "prefix": "<string>",
              "suffix": "<string>",
              "custom": "<string>"
            },
            "baseMetricId": "<string>",
            "timeDimensionId": "<string>",
            "periodOffset": 123
          }
        ]
      }
    }
  }
}

Path Parameters

projectUuid · string · required

agentUuid · string · required

artifactUuid · string · required

versionUuid · string · required

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok