API Reference

Evaluation Dashboards

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Evaluation Dashboard

client.EvaluationDashboards.Archive(ctx, dashboardID) (*EvaluationDashboard, error)

DELETE/v5/evaluation-dashboards/{dashboard_id}

Soft-delete a dashboard by setting its archived timestamp.

The dashboard row is retained and marked archived rather than physically removed, so it stops appearing in default listings but can still be fetched with include_archived=true; the archived dashboard is returned by this call. Associated widgets and widget results are not deleted or detached. Returns a not-found error if the dashboard does not exist in the caller’s account.

ParametersExpand Collapse

dashboardID string

ReturnsExpand Collapse

type EvaluationDashboard struct{…}

ID string

Unique identifier of the dashboard

AccountID string

Account that owns this dashboard

CreatedAt Time

When the dashboard was created

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

Name string

Dashboard name

Tags []string

The tags associated with the entity

UpdatedAt Time

When the dashboard was last updated

formatdate-time

ArchivedAt TimeOptional

When the dashboard was archived (soft-deleted)

formatdate-time

Description stringOptional

Dashboard description

ErrorMessage stringOptional

Error message if computation failed

EvaluationGroupID stringOptional

Evaluation group ID

EvaluationID stringOptional

Evaluation ID

Object EvaluationDashboardObjectOptional

WidgetOrder []stringOptional

Ordered array of widget IDs

WidgetResults []EvaluationDashboardWidgetResultOptional

Widget results for this dashboard. Populated with ‘widget_results’ view.

ID string

Unique identifier of the widget result

AccountID string

Account that owns this widget result

ComputationStatus EvaluationDashboardWidgetResultComputationStatus

Status of the computation

One of the following:

const EvaluationDashboardWidgetResultComputationStatusPending EvaluationDashboardWidgetResultComputationStatus = "pending"

const EvaluationDashboardWidgetResultComputationStatusCompleted EvaluationDashboardWidgetResultComputationStatus = "completed"

const EvaluationDashboardWidgetResultComputationStatusFailed EvaluationDashboardWidgetResultComputationStatus = "failed"

CreatedAt Time

When the widget result was created

formatdate-time

WidgetID string

Unique identifier of the widget

ComputationJobID stringOptional

Temporal workflow ID or job ID for async computation tracking

ComputedAt TimeOptional

Timestamp when computation completed successfully

formatdate-time

ComputedResult map[string, any]Optional

Cached computation results

ErrorMessage stringOptional

Error message if computation failed

EvaluationGroupID stringOptional

FK to evaluation_groups. Null if result is for a single evaluation.

EvaluationID stringOptional

FK to evaluations. Null if result is for an evaluation group.

Object EvaluationDashboardWidgetResultObjectOptional

Widget EvaluationDashboardWidgetOptional

Widget that this result is for

ID string

Unique identifier of the widget

AccountID string

Account that owns this widget

CreatedAt Time

When the widget was created

formatdate-time

Title string

Widget title

Type EvaluationWidgetTypeEnum

Widget type

One of the following:

const EvaluationWidgetTypeEnumBar EvaluationWidgetTypeEnum = "bar"

const EvaluationWidgetTypeEnumHistogram EvaluationWidgetTypeEnum = "histogram"

const EvaluationWidgetTypeEnumDonut EvaluationWidgetTypeEnum = "donut"

const EvaluationWidgetTypeEnumScatter EvaluationWidgetTypeEnum = "scatter"

const EvaluationWidgetTypeEnumMetric EvaluationWidgetTypeEnum = "metric"

const EvaluationWidgetTypeEnumTable EvaluationWidgetTypeEnum = "table"

const EvaluationWidgetTypeEnumMarkdown EvaluationWidgetTypeEnum = "markdown"

const EvaluationWidgetTypeEnumHeading EvaluationWidgetTypeEnum = "heading"

const EvaluationWidgetTypeEnumTimeseries EvaluationWidgetTypeEnum = "timeseries"

ArchivedAt TimeOptional

When the widget was archived (soft-deleted)

formatdate-time

Config map[string, any]Optional

Chart-specific display configuration

Object EvaluationDashboardWidgetObjectOptional

Query EvaluationDashboardWidgetQueryUnionOptional

Structured query AST for metric computation (SeriesQuery or MetricQuery)

One of the following:

type SeriesQuery struct{…}

Query that returns a series of records (used for table/bar/histogram/donut/scatter widgets).

Used for widget types: table, bar, histogram, donut, scatter. Returns: {“type”: “series”, “data”: […]}

Example SQL equivalent: SELECT category, AVG(score) as avg_score, COUNT(*) as count FROM evaluation_items WHERE score > 0.5 AND category = ‘test’ GROUP BY category ORDER BY avg_score DESC LIMIT 100

Select []SelectItem

Expression SelectItemExpressionUnion

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

One of the following:

type SelectItemExpressionColumn struct{…}

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

Column string

Column name from evaluation_items.data

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

type SelectItemExpressionAggregation struct{…}

Aggregation function to apply

Examples: {“type”: “AGGREGATION”, “function”: “AVG”, “column”: “score”} {“type”: “AGGREGATION”, “function”: “COUNT”, “column”: ”*”} {“type”: “AGGREGATION”, “function”: “PERCENTILE”, “column”: “score”, “params”: {“percentile”: 95}}

Column string

Column to aggregate, or '' for COUNT()

Function string

Supported aggregation functions

One of the following:

const SelectItemExpressionAggregationFunctionCount SelectItemExpressionAggregationFunction = "COUNT"

const SelectItemExpressionAggregationFunctionSum SelectItemExpressionAggregationFunction = "SUM"

const SelectItemExpressionAggregationFunctionAvg SelectItemExpressionAggregationFunction = "AVG"

const SelectItemExpressionAggregationFunctionMin SelectItemExpressionAggregationFunction = "MIN"

const SelectItemExpressionAggregationFunctionMax SelectItemExpressionAggregationFunction = "MAX"

const SelectItemExpressionAggregationFunctionStddev SelectItemExpressionAggregationFunction = "STDDEV"

const SelectItemExpressionAggregationFunctionVariance SelectItemExpressionAggregationFunction = "VARIANCE"

const SelectItemExpressionAggregationFunctionPercentile SelectItemExpressionAggregationFunction = "PERCENTILE"

const SelectItemExpressionAggregationFunctionCountDistinct SelectItemExpressionAggregationFunction = "COUNT_DISTINCT"

const SelectItemExpressionAggregationFunctionPercentage SelectItemExpressionAggregationFunction = "PERCENTAGE"

EvaluationIDs []stringOptional

Optional subset of evaluation IDs for per-aggregation filtering in evaluation group dashboards.

Params map[string, any]Optional

Function parameters (e.g., {‘percentile’: 95} for PERCENTILE, {‘percentage_filters’: Filter} for PERCENTAGE)

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

Alias stringOptional

Optional alias for the selected item

EvaluationIDs []stringOptional

Optional subset of evaluation IDs to compute on. Only applicable for evaluation group dashboards. If omitted, computes on all evaluations in the group.

Filter FilterOptional

Filter conditions (WHERE clause)

Conditions []FilterCondition

Column string

Column name to filter on

Operator string

Comparison operator

One of the following:

const FilterConditionOperatorEquals FilterConditionOperator = "="

const FilterConditionOperatorNotEquals FilterConditionOperator = "!="

const FilterConditionOperatorGreater FilterConditionOperator = ">"

const FilterConditionOperatorLess FilterConditionOperator = "<"

const FilterConditionOperatorGreaterOrEquals FilterConditionOperator = ">="

const FilterConditionOperatorLessOrEquals FilterConditionOperator = "<="

const FilterConditionOperatorIn FilterConditionOperator = "IN"

const FilterConditionOperatorNotIn FilterConditionOperator = "NOT IN"

const FilterConditionOperatorLike FilterConditionOperator = "LIKE"

const FilterConditionOperatorNotLike FilterConditionOperator = "NOT LIKE"

const FilterConditionOperatorIsNull FilterConditionOperator = "IS NULL"

const FilterConditionOperatorIsNotNull FilterConditionOperator = "IS NOT NULL"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Value FilterConditionValueUnionOptional

Value to compare against. Not required for IS NULL / IS NOT NULL operators.

One of the following:

string

float64

bool

type FilterConditionValueArray []any

LogicalOperators []stringOptional

Logical operators connecting conditions. Length must be len(conditions) - 1

One of the following:

const FilterLogicalOperatorAnd FilterLogicalOperator = "AND"

const FilterLogicalOperatorOr FilterLogicalOperator = "OR"

GroupBy []stringOptional

Columns to group by

LatestOnly boolOptional

When True, the widget computes against rows from only the most recent active evaluation in the group (by EvaluationORM.created_at). Only applicable for evaluation group dashboards. Composes with evaluation_ids (latest within the subset). Cannot be combined with per-aggregation evaluation_ids; the use case enforces these rules.

Limit int64Optional

Max rows to return

minimum1

OrderBy []SeriesQueryOrderByOptional

Sort order

Column string

Column name to sort by

Direction stringOptional

Sort direction

One of the following:

const SeriesQueryOrderByDirectionAsc SeriesQueryOrderByDirection = "ASC"

const SeriesQueryOrderByDirectionDesc SeriesQueryOrderByDirection = "DESC"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

type MetricQuery struct{…}

Query that returns a single metric value (used for metric widgets).

Used for widget type: metric. Enforces exactly 1 aggregation in select. Returns: {“type”: “metric”, “data”: …}

Example SQL equivalent: SELECT AVG(score) as average_score FROM evaluation_items

Select []SelectItem

Expression SelectItemExpressionUnion

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

One of the following:

type SelectItemExpressionColumn struct{…}

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

Column string

Column name from evaluation_items.data

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

type SelectItemExpressionAggregation struct{…}

Aggregation function to apply

Examples: {“type”: “AGGREGATION”, “function”: “AVG”, “column”: “score”} {“type”: “AGGREGATION”, “function”: “COUNT”, “column”: ”*”} {“type”: “AGGREGATION”, “function”: “PERCENTILE”, “column”: “score”, “params”: {“percentile”: 95}}

Column string

Column to aggregate, or '' for COUNT()

Function string

Supported aggregation functions

One of the following:

const SelectItemExpressionAggregationFunctionCount SelectItemExpressionAggregationFunction = "COUNT"

const SelectItemExpressionAggregationFunctionSum SelectItemExpressionAggregationFunction = "SUM"

const SelectItemExpressionAggregationFunctionAvg SelectItemExpressionAggregationFunction = "AVG"

const SelectItemExpressionAggregationFunctionMin SelectItemExpressionAggregationFunction = "MIN"

const SelectItemExpressionAggregationFunctionMax SelectItemExpressionAggregationFunction = "MAX"

const SelectItemExpressionAggregationFunctionStddev SelectItemExpressionAggregationFunction = "STDDEV"

const SelectItemExpressionAggregationFunctionVariance SelectItemExpressionAggregationFunction = "VARIANCE"

const SelectItemExpressionAggregationFunctionPercentile SelectItemExpressionAggregationFunction = "PERCENTILE"

const SelectItemExpressionAggregationFunctionCountDistinct SelectItemExpressionAggregationFunction = "COUNT_DISTINCT"

const SelectItemExpressionAggregationFunctionPercentage SelectItemExpressionAggregationFunction = "PERCENTAGE"

EvaluationIDs []stringOptional

Optional subset of evaluation IDs for per-aggregation filtering in evaluation group dashboards.

Params map[string, any]Optional

Function parameters (e.g., {‘percentile’: 95} for PERCENTILE, {‘percentage_filters’: Filter} for PERCENTAGE)

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

Alias stringOptional

Optional alias for the selected item

EvaluationIDs []stringOptional

Optional subset of evaluation IDs to compute on. Only applicable for evaluation group dashboards. If omitted, computes on all evaluations in the group.

Filter FilterOptional

Filter conditions (WHERE clause)

Conditions []FilterCondition

Column string

Column name to filter on

Operator string

Comparison operator

One of the following:

const FilterConditionOperatorEquals FilterConditionOperator = "="

const FilterConditionOperatorNotEquals FilterConditionOperator = "!="

const FilterConditionOperatorGreater FilterConditionOperator = ">"

const FilterConditionOperatorLess FilterConditionOperator = "<"

const FilterConditionOperatorGreaterOrEquals FilterConditionOperator = ">="

const FilterConditionOperatorLessOrEquals FilterConditionOperator = "<="

const FilterConditionOperatorIn FilterConditionOperator = "IN"

const FilterConditionOperatorNotIn FilterConditionOperator = "NOT IN"

const FilterConditionOperatorLike FilterConditionOperator = "LIKE"

const FilterConditionOperatorNotLike FilterConditionOperator = "NOT LIKE"

const FilterConditionOperatorIsNull FilterConditionOperator = "IS NULL"

const FilterConditionOperatorIsNotNull FilterConditionOperator = "IS NOT NULL"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Value FilterConditionValueUnionOptional

Value to compare against. Not required for IS NULL / IS NOT NULL operators.

One of the following:

string

float64

bool

type FilterConditionValueArray []any

LogicalOperators []stringOptional

Logical operators connecting conditions. Length must be len(conditions) - 1

One of the following:

const FilterLogicalOperatorAnd FilterLogicalOperator = "AND"

const FilterLogicalOperatorOr FilterLogicalOperator = "OR"

LatestOnly boolOptional

When True, the widget computes against rows from only the most recent active evaluation in the group (by EvaluationORM.created_at). Only applicable for evaluation group dashboards. Composes with evaluation_ids (latest within the subset). Cannot be combined with per-aggregation evaluation_ids; the use case enforces these rules.

Widgets []EvaluationDashboardWidgetOptional

Widgets associated with this dashboard. Populated with ‘widgets’ view.

ID string

Unique identifier of the widget

AccountID string

Account that owns this widget

CreatedAt Time

When the widget was created

formatdate-time

Title string

Widget title

Type EvaluationWidgetTypeEnum

Widget type

One of the following:

const EvaluationWidgetTypeEnumBar EvaluationWidgetTypeEnum = "bar"

const EvaluationWidgetTypeEnumHistogram EvaluationWidgetTypeEnum = "histogram"

const EvaluationWidgetTypeEnumDonut EvaluationWidgetTypeEnum = "donut"

const EvaluationWidgetTypeEnumScatter EvaluationWidgetTypeEnum = "scatter"

const EvaluationWidgetTypeEnumMetric EvaluationWidgetTypeEnum = "metric"

const EvaluationWidgetTypeEnumTable EvaluationWidgetTypeEnum = "table"

const EvaluationWidgetTypeEnumMarkdown EvaluationWidgetTypeEnum = "markdown"

const EvaluationWidgetTypeEnumHeading EvaluationWidgetTypeEnum = "heading"

const EvaluationWidgetTypeEnumTimeseries EvaluationWidgetTypeEnum = "timeseries"

ArchivedAt TimeOptional

When the widget was archived (soft-deleted)

formatdate-time

Config map[string, any]Optional

Chart-specific display configuration

Object EvaluationDashboardWidgetObjectOptional

Query EvaluationDashboardWidgetQueryUnionOptional

Structured query AST for metric computation (SeriesQuery or MetricQuery)

One of the following:

type SeriesQuery struct{…}

Query that returns a series of records (used for table/bar/histogram/donut/scatter widgets).

Used for widget types: table, bar, histogram, donut, scatter. Returns: {“type”: “series”, “data”: […]}

Example SQL equivalent: SELECT category, AVG(score) as avg_score, COUNT(*) as count FROM evaluation_items WHERE score > 0.5 AND category = ‘test’ GROUP BY category ORDER BY avg_score DESC LIMIT 100

Select []SelectItem

Expression SelectItemExpressionUnion

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

One of the following:

type SelectItemExpressionColumn struct{…}

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

Column string

Column name from evaluation_items.data

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

type SelectItemExpressionAggregation struct{…}

Aggregation function to apply

Examples: {“type”: “AGGREGATION”, “function”: “AVG”, “column”: “score”} {“type”: “AGGREGATION”, “function”: “COUNT”, “column”: ”*”} {“type”: “AGGREGATION”, “function”: “PERCENTILE”, “column”: “score”, “params”: {“percentile”: 95}}

Column string

Column to aggregate, or '' for COUNT()

Function string

Supported aggregation functions

One of the following:

const SelectItemExpressionAggregationFunctionCount SelectItemExpressionAggregationFunction = "COUNT"

const SelectItemExpressionAggregationFunctionSum SelectItemExpressionAggregationFunction = "SUM"

const SelectItemExpressionAggregationFunctionAvg SelectItemExpressionAggregationFunction = "AVG"

const SelectItemExpressionAggregationFunctionMin SelectItemExpressionAggregationFunction = "MIN"

const SelectItemExpressionAggregationFunctionMax SelectItemExpressionAggregationFunction = "MAX"

const SelectItemExpressionAggregationFunctionStddev SelectItemExpressionAggregationFunction = "STDDEV"

const SelectItemExpressionAggregationFunctionVariance SelectItemExpressionAggregationFunction = "VARIANCE"

const SelectItemExpressionAggregationFunctionPercentile SelectItemExpressionAggregationFunction = "PERCENTILE"

const SelectItemExpressionAggregationFunctionCountDistinct SelectItemExpressionAggregationFunction = "COUNT_DISTINCT"

const SelectItemExpressionAggregationFunctionPercentage SelectItemExpressionAggregationFunction = "PERCENTAGE"

EvaluationIDs []stringOptional

Optional subset of evaluation IDs for per-aggregation filtering in evaluation group dashboards.

Params map[string, any]Optional

Function parameters (e.g., {‘percentile’: 95} for PERCENTILE, {‘percentage_filters’: Filter} for PERCENTAGE)

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

Alias stringOptional

Optional alias for the selected item

EvaluationIDs []stringOptional

Optional subset of evaluation IDs to compute on. Only applicable for evaluation group dashboards. If omitted, computes on all evaluations in the group.

Filter FilterOptional

Filter conditions (WHERE clause)

Conditions []FilterCondition

Column string

Column name to filter on

Operator string

Comparison operator

One of the following:

const FilterConditionOperatorEquals FilterConditionOperator = "="

const FilterConditionOperatorNotEquals FilterConditionOperator = "!="

const FilterConditionOperatorGreater FilterConditionOperator = ">"

const FilterConditionOperatorLess FilterConditionOperator = "<"

const FilterConditionOperatorGreaterOrEquals FilterConditionOperator = ">="

const FilterConditionOperatorLessOrEquals FilterConditionOperator = "<="

const FilterConditionOperatorIn FilterConditionOperator = "IN"

const FilterConditionOperatorNotIn FilterConditionOperator = "NOT IN"

const FilterConditionOperatorLike FilterConditionOperator = "LIKE"

const FilterConditionOperatorNotLike FilterConditionOperator = "NOT LIKE"

const FilterConditionOperatorIsNull FilterConditionOperator = "IS NULL"

const FilterConditionOperatorIsNotNull FilterConditionOperator = "IS NOT NULL"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Value FilterConditionValueUnionOptional

Value to compare against. Not required for IS NULL / IS NOT NULL operators.

One of the following:

string

float64

bool

type FilterConditionValueArray []any

LogicalOperators []stringOptional

Logical operators connecting conditions. Length must be len(conditions) - 1

One of the following:

const FilterLogicalOperatorAnd FilterLogicalOperator = "AND"

const FilterLogicalOperatorOr FilterLogicalOperator = "OR"

GroupBy []stringOptional

Columns to group by

LatestOnly boolOptional

When True, the widget computes against rows from only the most recent active evaluation in the group (by EvaluationORM.created_at). Only applicable for evaluation group dashboards. Composes with evaluation_ids (latest within the subset). Cannot be combined with per-aggregation evaluation_ids; the use case enforces these rules.

Limit int64Optional

Max rows to return

minimum1

OrderBy []SeriesQueryOrderByOptional

Sort order

Column string

Column name to sort by

Direction stringOptional

Sort direction

One of the following:

const SeriesQueryOrderByDirectionAsc SeriesQueryOrderByDirection = "ASC"

const SeriesQueryOrderByDirectionDesc SeriesQueryOrderByDirection = "DESC"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

type MetricQuery struct{…}

Query that returns a single metric value (used for metric widgets).

Used for widget type: metric. Enforces exactly 1 aggregation in select. Returns: {“type”: “metric”, “data”: …}

Example SQL equivalent: SELECT AVG(score) as average_score FROM evaluation_items

Select []SelectItem

Expression SelectItemExpressionUnion

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

One of the following:

type SelectItemExpressionColumn struct{…}

Reference to a column from evaluation_items.data

Example: {“type”: “COLUMN”, “column”: “category”}

Column string

Column name from evaluation_items.data

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

type SelectItemExpressionAggregation struct{…}

Aggregation function to apply

Examples: {“type”: “AGGREGATION”, “function”: “AVG”, “column”: “score”} {“type”: “AGGREGATION”, “function”: “COUNT”, “column”: ”*”} {“type”: “AGGREGATION”, “function”: “PERCENTILE”, “column”: “score”, “params”: {“percentile”: 95}}

Column string

Column to aggregate, or '' for COUNT()

Function string

Supported aggregation functions

One of the following:

const SelectItemExpressionAggregationFunctionCount SelectItemExpressionAggregationFunction = "COUNT"

const SelectItemExpressionAggregationFunctionSum SelectItemExpressionAggregationFunction = "SUM"

const SelectItemExpressionAggregationFunctionAvg SelectItemExpressionAggregationFunction = "AVG"

const SelectItemExpressionAggregationFunctionMin SelectItemExpressionAggregationFunction = "MIN"

const SelectItemExpressionAggregationFunctionMax SelectItemExpressionAggregationFunction = "MAX"

const SelectItemExpressionAggregationFunctionStddev SelectItemExpressionAggregationFunction = "STDDEV"

const SelectItemExpressionAggregationFunctionVariance SelectItemExpressionAggregationFunction = "VARIANCE"

const SelectItemExpressionAggregationFunctionPercentile SelectItemExpressionAggregationFunction = "PERCENTILE"

const SelectItemExpressionAggregationFunctionCountDistinct SelectItemExpressionAggregationFunction = "COUNT_DISTINCT"

const SelectItemExpressionAggregationFunctionPercentage SelectItemExpressionAggregationFunction = "PERCENTAGE"

EvaluationIDs []stringOptional

Optional subset of evaluation IDs for per-aggregation filtering in evaluation group dashboards.

Params map[string, any]Optional

Function parameters (e.g., {‘percentile’: 95} for PERCENTILE, {‘percentage_filters’: Filter} for PERCENTAGE)

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Type stringOptional

Alias stringOptional

Optional alias for the selected item

EvaluationIDs []stringOptional

Optional subset of evaluation IDs to compute on. Only applicable for evaluation group dashboards. If omitted, computes on all evaluations in the group.

Filter FilterOptional

Filter conditions (WHERE clause)

Conditions []FilterCondition

Column string

Column name to filter on

Operator string

Comparison operator

One of the following:

const FilterConditionOperatorEquals FilterConditionOperator = "="

const FilterConditionOperatorNotEquals FilterConditionOperator = "!="

const FilterConditionOperatorGreater FilterConditionOperator = ">"

const FilterConditionOperatorLess FilterConditionOperator = "<"

const FilterConditionOperatorGreaterOrEquals FilterConditionOperator = ">="

const FilterConditionOperatorLessOrEquals FilterConditionOperator = "<="

const FilterConditionOperatorIn FilterConditionOperator = "IN"

const FilterConditionOperatorNotIn FilterConditionOperator = "NOT IN"

const FilterConditionOperatorLike FilterConditionOperator = "LIKE"

const FilterConditionOperatorNotLike FilterConditionOperator = "NOT LIKE"

const FilterConditionOperatorIsNull FilterConditionOperator = "IS NULL"

const FilterConditionOperatorIsNotNull FilterConditionOperator = "IS NOT NULL"

Source stringOptional

Column source: ‘data’ or ‘task_result_cache’

Value FilterConditionValueUnionOptional

Value to compare against. Not required for IS NULL / IS NOT NULL operators.

One of the following:

string

float64

bool

type FilterConditionValueArray []any

LogicalOperators []stringOptional

Logical operators connecting conditions. Length must be len(conditions) - 1

One of the following:

const FilterLogicalOperatorAnd FilterLogicalOperator = "AND"

const FilterLogicalOperatorOr FilterLogicalOperator = "OR"

LatestOnly boolOptional

When True, the widget computes against rows from only the most recent active evaluation in the group (by EvaluationORM.created_at). Only applicable for evaluation group dashboards. Composes with evaluation_ids (latest within the subset). Cannot be combined with per-aggregation evaluation_ids; the use case enforces these rules.

Delete Evaluation Dashboard

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  evaluationDashboard, err := client.EvaluationDashboards.Archive(context.TODO(), "dashboard_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", evaluationDashboard.ID)
}

200 example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "tags": [
    "string"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "error_message": "error_message",
  "evaluation_group_id": "evaluation_group_id",
  "evaluation_id": "evaluation_id",
  "object": "evaluation_dashboard",
  "widget_order": [
    "string"
  ],
  "widget_results": [
    {
      "id": "id",
      "account_id": "account_id",
      "computation_status": "pending",
      "created_at": "2019-12-27T18:11:19.117Z",
      "widget_id": "widget_id",
      "computation_job_id": "computation_job_id",
      "computed_at": "2019-12-27T18:11:19.117Z",
      "computed_result": {
        "foo": "bar"
      },
      "error_message": "error_message",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_dashboard_widget_result",
      "widget": {
        "id": "id",
        "account_id": "account_id",
        "created_at": "2019-12-27T18:11:19.117Z",
        "title": "title",
        "type": "bar",
        "archived_at": "2019-12-27T18:11:19.117Z",
        "config": {
          "foo": "bar"
        },
        "object": "evaluation_dashboard_widget",
        "query": {
          "select": [
            {
              "expression": {
                "column": "column",
                "source": "source",
                "type": "COLUMN"
              },
              "alias": "alias"
            }
          ],
          "evaluation_ids": [
            "string"
          ],
          "filter": {
            "conditions": [
              {
                "column": "column",
                "operator": "=",
                "source": "source",
                "value": "string"
              }
            ],
            "logicalOperators": [
              "AND"
            ]
          },
          "groupBy": [
            "string"
          ],
          "latest_only": true,
          "limit": 1,
          "orderBy": [
            {
              "column": "column",
              "direction": "ASC",
              "source": "source"
            }
          ]
        }
      }
    }
  ],
  "widgets": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "title": "title",
      "type": "bar",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "config": {
        "foo": "bar"
      },
      "object": "evaluation_dashboard_widget",
      "query": {
        "select": [
          {
            "expression": {
              "column": "column",
              "source": "source",
              "type": "COLUMN"
            },
            "alias": "alias"
          }
        ],
        "evaluation_ids": [
          "string"
        ],
        "filter": {
          "conditions": [
            {
              "column": "column",
              "operator": "=",
              "source": "source",
              "value": "string"
            }
          ],
          "logicalOperators": [
            "AND"
          ]
        },
        "groupBy": [
          "string"
        ],
        "latest_only": true,
        "limit": 1,
        "orderBy": [
          {
            "column": "column",
            "direction": "ASC",
            "source": "source"
          }
        ]
      }
    }
  ]
}

Returns Examples

200 example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "tags": [
    "string"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "error_message": "error_message",
  "evaluation_group_id": "evaluation_group_id",
  "evaluation_id": "evaluation_id",
  "object": "evaluation_dashboard",
  "widget_order": [
    "string"
  ],
  "widget_results": [
    {
      "id": "id",
      "account_id": "account_id",
      "computation_status": "pending",
      "created_at": "2019-12-27T18:11:19.117Z",
      "widget_id": "widget_id",
      "computation_job_id": "computation_job_id",
      "computed_at": "2019-12-27T18:11:19.117Z",
      "computed_result": {
        "foo": "bar"
      },
      "error_message": "error_message",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_dashboard_widget_result",
      "widget": {
        "id": "id",
        "account_id": "account_id",
        "created_at": "2019-12-27T18:11:19.117Z",
        "title": "title",
        "type": "bar",
        "archived_at": "2019-12-27T18:11:19.117Z",
        "config": {
          "foo": "bar"
        },
        "object": "evaluation_dashboard_widget",
        "query": {
          "select": [
            {
              "expression": {
                "column": "column",
                "source": "source",
                "type": "COLUMN"
              },
              "alias": "alias"
            }
          ],
          "evaluation_ids": [
            "string"
          ],
          "filter": {
            "conditions": [
              {
                "column": "column",
                "operator": "=",
                "source": "source",
                "value": "string"
              }
            ],
            "logicalOperators": [
              "AND"
            ]
          },
          "groupBy": [
            "string"
          ],
          "latest_only": true,
          "limit": 1,
          "orderBy": [
            {
              "column": "column",
              "direction": "ASC",
              "source": "source"
            }
          ]
        }
      }
    }
  ],
  "widgets": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "title": "title",
      "type": "bar",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "config": {
        "foo": "bar"
      },
      "object": "evaluation_dashboard_widget",
      "query": {
        "select": [
          {
            "expression": {
              "column": "column",
              "source": "source",
              "type": "COLUMN"
            },
            "alias": "alias"
          }
        ],
        "evaluation_ids": [
          "string"
        ],
        "filter": {
          "conditions": [
            {
              "column": "column",
              "operator": "=",
              "source": "source",
              "value": "string"
            }
          ],
          "logicalOperators": [
            "AND"
          ]
        },
        "groupBy": [
          "string"
        ],
        "latest_only": true,
        "limit": 1,
        "orderBy": [
          {
            "column": "column",
            "direction": "ASC",
            "source": "source"
          }
        ]
      }
    }
  ]
}