Skip to main content

Module api

Module api 

Source

Modules§

all_runs_properties_and_labels_response
archive_runs_request
assets_filter
batch_edit_run_metadata_request
batch_edit_run_metadata_response
channel_metadata
check_alert_states_filter
connection_rid
create_or_update_run_request
create_run_data_source
create_run_request
custom_timeframe_filter
data_review_alert_metrics
data_review_check_metrics
data_review_metrics
data_scopes
data_source
data_source_series_tag
data_source_type
duration
get_run_by_id_request
get_runs_by_asset_request
get_runs_by_asset_response
link
log_set_rid
preset_timeframe_duration
preset_timeframe_filter
ref_name_and_type
run
run_data_review_evaluation_status
run_data_review_summary
run_data_source
run_rid
run_with_data_review_metrics
run_with_data_review_summary
search_query
search_run_channels_request
search_run_channels_response
search_runs_request
search_runs_response
search_runs_with_data_review_metrics_response
search_runs_with_data_review_summary_response
sort_field
sort_key
sort_options
sort_property
time_range_filter
timeframe_filter
unarchive_runs_request
unit
update_attachments_request
update_run_request
utc_timestamp
weak_timestamp_type

Structs§

AllRunsPropertiesAndLabelsResponse
ArchiveRunsRequest
AssetsFilter
returns runs that match any of the provided assets.
BatchEditRunMetadataRequest
BatchEditRunMetadataResponse
ChannelMetadata
CheckAlertStatesFilter
ConnectionRid
CreateOrUpdateRunRequest
CreateRunDataSource
For write requests, we want to allow for optional fields
CreateRunRequest
CustomTimeframeFilter
DataReviewAlertMetrics
DataReviewCheckMetrics
DataReviewMetrics
DataScopes
DataSourceSeriesTag
Duration
GetRunByIdRequest
GetRunsByAssetRequest
GetRunsByAssetResponse
Link
LogSetRid
PresetTimeframeFilter
RefNameAndType
Scoped to the org-level, intended to help the frontend prevent users from submitting invalid ref names, ex. using a dataset ref name for a connection data source
Run
RunDataReviewSummary
RunDataSource
For read requests, we want to require all fields
RunRid
RunWithDataReviewMetrics
RunWithDataReviewSummary
SearchRunChannelsRequest
SearchRunChannelsResponse
SearchRunsRequest
SearchRunsResponse
SearchRunsWithDataReviewMetricsResponse
SearchRunsWithDataReviewSummaryResponse
SortOptions
SortProperty
TimeRangeFilter
searches for runs that have at least some intersection with the specified range.
UnarchiveRunsRequest
Unit
UpdateAttachmentsRequest
UpdateRunRequest
UtcTimestamp

Enums§

DataSource
DataSourceType
PresetTimeframeDuration
RunDataReviewEvaluationStatus
SearchQuery
SortField
SortKey
TimeframeFilter
WeakTimestampType
If a CSV data source is still being split, the timestamp type is not known.