Apache

Superset

Superset

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Superset

Endpoints 329

Advanced Data Type

  • GETReturn an AdvancedDataTypeResponse/api/v1/advanced_data_type/convert?q=Returns an AdvancedDataTypeResponse object populated with the passed in args.
  • GETReturn a list of available advanced data types/api/v1/advanced_data_type/types

Annotation Layers

  • GETGet a list of annotation layers/api/v1/annotation_layer/?q=Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate an annotation layer/api/v1/annotation_layer/
  • DELETEDelete multiple annotation layers in a bulk operation/api/v1/annotation_layer/?q=
  • GETGet metadata information about this API resource/api/v1/annotation_layer/_info?q=Get metadata information about this API resource
  • GETGet related fields data/api/v1/annotation_layer/related/:column_name?q=
  • GETGet an annotation layer/api/v1/annotation_layer/:pk?q=Get an item model
  • PUTUpdate an annotation layer/api/v1/annotation_layer/:pk
  • DELETEDelete annotation layer/api/v1/annotation_layer/:pk
  • GETGet a list of annotation layers/api/v1/annotation_layer/:pk/annotation/?q=Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate an annotation layer/api/v1/annotation_layer/:pk/annotation/
  • DELETEBulk delete annotation layers/api/v1/annotation_layer/:pk/annotation/?q=
  • GETGet an annotation layer/api/v1/annotation_layer/:pk/annotation/:annotation_id?q=
  • PUTUpdate an annotation layer/api/v1/annotation_layer/:pk/annotation/:annotation_id
  • DELETEDelete annotation layer/api/v1/annotation_layer/:pk/annotation/:annotation_id

Import/export

  • GETExport all assets/api/v1/assets/export/Gets a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files.
  • POSTImport multiple assets/api/v1/assets/import/

Available Domains

  • GETGet all available domains/api/v1/available_domains/

CacheRestApi

  • POSTInvalidate cache records and remove the database records/api/v1/cachekey/invalidateTakes a list of datasources, finds and invalidates the associated cache records and removes the database records.

Charts

  • GETGet a list of charts/api/v1/chart/?q=Gets a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a new chart/api/v1/chart/
  • DELETEBulk delete charts (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/?q=
  • GETGet metadata information about this API resource/api/v1/chart/_info?q=Get metadata information about this API resource
  • POSTReturn payload data response for the given query/api/v1/chart/dataTakes a query context constructed in the client and returns payload data response for the given query.
  • POSTCancel a running chart-data query/api/v1/chart/data/stopCancels the warehouse query started by a chart-data request that carried the given client_id, for databases whose engine supports query cancellation. The…
  • GETDownload multiple charts as YAML files/api/v1/chart/export/?q=
  • GETCheck favorited charts for current user/api/v1/chart/favorite_status/?q=
  • POSTImport chart(s) with associated datasets and databases/api/v1/chart/import/
  • GETGet related fields data/api/v1/chart/related/:column_name?q=Get a list of all possible related entities for a chart. Use editors as the column_name parameter
  • PUTWarm up the cache for the chart/api/v1/chart/warm_up_cacheWarms up the cache for the chart. Note for slices a force refresh occurs. In terms of the extra_filters these can be obtained from records in the JSON encoded…
  • GETGet a chart detail information/api/v1/chart/:id_or_uuidGet a chart
  • PUTUpdate a chart/api/v1/chart/:pk
  • DELETEDelete a chart (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/:pk
  • GETCompute and cache a screenshot/api/v1/chart/:pk/cache_screenshot/?q=
  • GETReturn payload data response for a chart/api/v1/chart/:pk/data/?format=string&type=string&force=true&filters_dashboard_id=0Takes a chart ID and uses the query context stored when the chart was saved to return payload data response. When filters_dashboard_id is provided, the…
  • GETGet the sub-layer charts declared by a deck.gl Multiple Layers chart/api/v1/chart/:pk/deck_layers/Multiple Layers charts (viz_type "deck_multi") reference other saved charts as layers via their deck_slices config, but those layer charts typically sit on no…
  • POSTMark the chart as favorite for the current user/api/v1/chart/:pk/favorites/
  • DELETERemove the chart from the user favorite list/api/v1/chart/:pk/favorites/
  • GETGet a computed screenshot from cache/api/v1/chart/:pk/screenshot/:digest/
  • GETGet chart thumbnail/api/v1/chart/:pk/thumbnail/:digest/Compute or get already computed chart thumbnail from cache.
  • GETActivity stream — chart own edits + datasets the chart pointed at during association/api/v1/chart/:uuid_str/activity/?since=2024-01-01T00:00:00Z&until=2024-01-01T00:00:00Z&include=all&q=string&page=0&page_size=25
  • GETReturn the version history for a chart/api/v1/chart/:uuid_str/versions/
  • GETRead-only snapshot of the chart at a given version/api/v1/chart/:uuid_str/versions/:version_uuid_str/
  • POSTRevert a chart to an earlier version (non-destructive)/api/v1/chart/:uuid_str/versions/:version_uuid_str/restore
  • POSTPermanently delete a soft-deleted chart/api/v1/chart/:uuid/purgeIrreversibly remove an archived chart and its dependents. Limited to owners and admins (same audience as restore).
  • POSTRestore a soft-deleted chart/api/v1/chart/:uuid/restore

CSS Templates

  • GETGet a list of CSS templates/api/v1/css_template/?q=Gets a list of CSS templates, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a CSS template/api/v1/css_template/
  • DELETEBulk delete CSS templates/api/v1/css_template/?q=
  • GETGet metadata information about this API resource/api/v1/css_template/_info?q=Get metadata information about this API resource
  • GETGet related fields data/api/v1/css_template/related/:column_name?q=
  • GETGet a CSS template/api/v1/css_template/:pk?q=Get an item model
  • PUTUpdate a CSS template/api/v1/css_template/:pk
  • DELETEDelete a CSS template/api/v1/css_template/:pk

Dashboards

  • GETGet a list of dashboards/api/v1/dashboard/?q=Gets a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a new dashboard/api/v1/dashboard/
  • DELETEBulk delete dashboards (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dashboard/?q=
  • GETGet metadata information about this API resource/api/v1/dashboard/_info?q=Get metadata information about this API resource
  • GETDownload multiple dashboards as YAML files/api/v1/dashboard/export/?q=
  • GETDownload a completed dashboard Excel export/api/v1/dashboard/export_xlsx/download/:job_id/Intentionally requires no login: the unguessable job_id, emailed only to the original requester (or handed to their own session via export_xlsx_status), is…
  • GETPoll the status of a dashboard Excel export job/api/v1/dashboard/export_xlsx/status/:job_id/For a session with no email address to be notified at (e.g. an embedded/guest session), the frontend polls this endpoint with the job_id from the export_xlsx…
  • GETCheck favorited dashboards for current user/api/v1/dashboard/favorite_status/?q=
  • POSTImport dashboard(s) with associated charts/datasets/databases/api/v1/dashboard/import/
  • GETGet related fields data/api/v1/dashboard/related/:column_name?q=Get a list of all possible related entities for a dashboard
  • GETGet a dashboard detail information/api/v1/dashboard/:id_or_slug?q=
  • GETGet a dashboard's chart definitions./api/v1/dashboard/:id_or_slug/charts
  • POSTCreate a copy of an existing dashboard/api/v1/dashboard/:id_or_slug/copy/Settings merge with the source by default. Set replace_metadata to true to use json_metadata as complete settings, as for a version fork. Chart-specific…
  • GETGet dashboard's datasets/api/v1/dashboard/:id_or_slug/datasetsReturns a list of a dashboard's datasets. Each dataset includes only the information necessary to render the dashboard's charts.
  • GETGet the dashboard's embedded configuration/api/v1/dashboard/:id_or_slug/embedded
  • PUTPUT /api/v1/dashboard/{id_or_slug}/embedded/api/v1/dashboard/:id_or_slug/embeddedSets a dashboard's embedded configuration.
  • POSTSet a dashboard's embedded configuration/api/v1/dashboard/:id_or_slug/embedded
  • DELETEDelete a dashboard's embedded configuration/api/v1/dashboard/:id_or_slug/embedded
  • GETGet dashboard's tabs/api/v1/dashboard/:id_or_slug/tabsReturns a list of a dashboard's tabs and dashboard's nested tree structure for associated tabs.
  • PUTUpdate a dashboard/api/v1/dashboard/:pk
  • DELETEDelete a dashboard (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dashboard/:pk
  • POSTCompute and cache a screenshot/api/v1/dashboard/:pk/cache_dashboard_screenshot/
  • PUTUpdate chart customizations configuration for a dashboard./api/v1/dashboard/:pk/chart_customizations
  • PUTUpdate colors configuration for a dashboard./api/v1/dashboard/:pk/colors?mark_updated=true
  • GETExport dashboard as example bundle/api/v1/dashboard/:pk/export_as_example/?export_data=true&sample_rows=0Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and…
  • POSTExport dashboard chart data to Excel/api/v1/dashboard/:pk/export_xlsx/Writes each chart to a worksheet. With export storage configured, the work is queued: the requesting user is emailed a download link when they have an address…
  • POSTMark the dashboard as favorite for the current user/api/v1/dashboard/:pk/favorites/
  • DELETERemove the dashboard from the user favorite list/api/v1/dashboard/:pk/favorites/
  • PUTUpdate native filters configuration for a dashboard./api/v1/dashboard/:pk/filters
  • GETGet a computed screenshot from cache/api/v1/dashboard/:pk/screenshot/:digest/?download_format=png
  • GETGet dashboard's thumbnail/api/v1/dashboard/:pk/thumbnail/:digest/Computes async or get already computed dashboard thumbnail from cache.
  • GETActivity stream — dashboard own edits + transitive chart-on-dashboard and dataset-via-chart edits, time-bounded by association windows/api/v1/dashboard/:uuid_str/activity/?since=2024-01-01T00:00:00Z&until=2024-01-01T00:00:00Z&include=all&q=string&page=0&page_size=25
  • GETReturn the version history for a dashboard/api/v1/dashboard/:uuid_str/versions/
  • GETRead-only snapshot of the dashboard at a given version/api/v1/dashboard/:uuid_str/versions/:version_uuid_str/?include_restore_impact=false
  • POSTRevert a dashboard to an earlier version (non-destructive)/api/v1/dashboard/:uuid_str/versions/:version_uuid_str/restore
  • POSTPermanently delete a soft-deleted dashboard/api/v1/dashboard/:uuid/purgeIrreversibly remove an archived dashboard and its dependents. Limited to owners and admins (same audience as restore).
  • POSTRestore a soft-deleted dashboard/api/v1/dashboard/:uuid/restore

Dashboard Permanent Link

  • GETGet dashboard's permanent link state/api/v1/dashboard/permalink/:key
  • POSTCreate a new dashboard's permanent link/api/v1/dashboard/:pk/permalink

Dashboard Filter State

  • POSTCreate a dashboard's filter state/api/v1/dashboard/:pk/filter_state?tab_id=0
  • GETGet a dashboard's filter state value/api/v1/dashboard/:pk/filter_state/:key
  • PUTUpdate a dashboard's filter state value/api/v1/dashboard/:pk/filter_state/:key?tab_id=0
  • DELETEDelete a dashboard's filter state value/api/v1/dashboard/:pk/filter_state/:key?tab_id=0

Database

  • GETGet a list of databases/api/v1/database/?q=Gets a list of databases, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a new database/api/v1/database/
  • GETGet metadata information about this API resource/api/v1/database/_info?q=Get metadata information about this API resource
  • GETGet names of databases currently available/api/v1/database/available/
  • GETDownload database(s) and associated dataset(s) as a zip file/api/v1/database/export/?q=
  • POSTImport database(s) with associated datasets/api/v1/database/import/
  • GETReceive personal access tokens from OAuth2/api/v1/database/oauth2/?state=string&code=string&scope=string&error=string-> Receive and store personal access tokens from OAuth for user-level authorization
  • GETGet related fields data/api/v1/database/related/:column_name?q=
  • POSTTest a database connection/api/v1/database/test_connection/
  • POSTUpload a file and returns file metadata/api/v1/database/upload_metadata/
  • POSTValidate database connection parameters/api/v1/database/validate_parameters/
  • GETGet a database/api/v1/database/:pk
  • PUTChange a database/api/v1/database/:pk
  • DELETEDelete a database/api/v1/database/:pk
  • GETGet all catalogs from a database/api/v1/database/:pk/catalogs/?q=
  • GETGet a database connection info/api/v1/database/:pk/connection
  • GETGet function names supported by a database/api/v1/database/:pk/function_names/
  • GETList OAuth2 credential metadata for a database/api/v1/database/:pk/oauth2_tokens/?q=
  • POSTDelete all OAuth2 access and refresh tokens for a DB connection./api/v1/database/:pk/oauth2_tokens/all/
  • POSTDelete OAuth2 access and refresh tokens for a DB connection./api/v1/database/:pk/oauth2_tokens/delete/
  • GETGet charts and dashboards count associated to a database/api/v1/database/:pk/related_objects/
  • GETGet all schemas from a database/api/v1/database/:pk/schemas/?q=
  • GETThe list of the database schemas where to upload information/api/v1/database/:pk/schemas_access_for_file_upload/
  • GETGet database select star for table/api/v1/database/:pk/select_star/:table_name/
  • GETGet database select star for table/api/v1/database/:pk/select_star/:table_name/:schema_name/
  • POSTRe-sync all permissions for a database connection/api/v1/database/:pk/sync_permissions/
  • GETGet database table metadata/api/v1/database/:pk/table/:table_name/:schema_name/
  • GETGet table extra metadata/api/v1/database/:pk/table_extra/:table_name/:schema_name/Response depends on each DB engine spec normally focused on partitions.
  • GETGet table metadata/api/v1/database/:pk/table_metadata/?name=string&schema=string&catalog=stringMetadata associated with the table (columns, indexes, etc.)
  • GETGet table extra metadata/api/v1/database/:pk/table_metadata/extra/?name=string&schema=string&catalog=stringExtra metadata associated with the table (partitions, description, etc.)
  • GETGet a list of tables for given database/api/v1/database/:pk/tables/?q=
  • POSTUpload a file to a database table/api/v1/database/:pk/upload/
  • POSTValidate arbitrary SQL/api/v1/database/:pk/validate_sql/Validates that arbitrary SQL is acceptable for the given database.

Datasets

  • GETGet a list of datasets/api/v1/dataset/?q=Gets a list of datasets, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a new dataset/api/v1/dataset/
  • DELETEBulk delete datasets (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dataset/?q=
  • GETGet metadata information about this API resource/api/v1/dataset/_info?q=Get metadata information about this API resource
  • GETGet distinct values from field data/api/v1/dataset/distinct/:column_name?q=
  • POSTDuplicate a dataset/api/v1/dataset/duplicate
  • GETDownload multiple datasets as YAML files/api/v1/dataset/export/?q=
  • POSTRetrieve a table by name, or create it if it does not exist/api/v1/dataset/get_or_create/
  • POSTImport dataset(s) with associated databases/api/v1/dataset/import/
  • GETGet related fields data/api/v1/dataset/related/:column_name?q=
  • GETGet charts and dashboards associated to multiple datasets/api/v1/dataset/related_objects/?q=Aggregates the charts built on any of the requested datasets and the dashboards that depend on them, through those charts or through a native filter or…
  • PUTWarm up the cache for each chart powered by the given table/api/v1/dataset/warm_up_cacheWarms up the cache for the table. Note for slices a force refresh occurs. In terms of the extra_filters these can be obtained from records in the JSON encoded…
  • GETGet a dataset/api/v1/dataset/:id_or_uuid?q=&include_rendered_sql=trueGet a dataset by ID
  • GETGet charts and dashboards count associated to a dataset/api/v1/dataset/:id_or_uuid/related_objects
  • PUTUpdate a dataset/api/v1/dataset/:pk?override_columns=true
  • DELETEDelete a dataset (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dataset/:pk
  • DELETEDelete a dataset column/api/v1/dataset/:pk/column/:column_id
  • GETGet dataset drill info/api/v1/dataset/:pk/drill_info/
  • DELETEDelete a dataset metric/api/v1/dataset/:pk/metric/:metric_id
  • POSTPreview a partition filter mapping/api/v1/dataset/:pk/partition_mapping/preview/Evaluate a partition value transform at sample values and return the predicate that would be appended to queries. The predicate is built by the same code the…
  • PUTRefresh and update columns of a dataset/api/v1/dataset/:pk/refresh
  • GETGet a dataset's activity stream/api/v1/dataset/:uuid_str/activity/?since=2024-01-01T00:00:00Z&until=2024-01-01T00:00:00Z&include=all&q=string&page=0&page_size=25A dataset's own edits only. Datasets have no transitive layer in V2 — chart and dashboard edits that touch this dataset do NOT appear here. ?include=self and…
  • GETReturn the version history for a dataset/api/v1/dataset/:uuid_str/versions/
  • GETRead-only snapshot of the dataset at a given version/api/v1/dataset/:uuid_str/versions/:version_uuid_str/Returns the dataset's scalar fields plus reconstructed columns and metrics lists as they were at the target version. Does not modify live state.
  • POSTRevert a dataset to an earlier version (non-destructive)/api/v1/dataset/:uuid_str/versions/:version_uuid_str/restore
  • POSTPermanently delete a soft-deleted dataset/api/v1/dataset/:uuid/purgeIrreversibly remove an archived dataset and its dependents. Limited to owners and admins (same audience as restore).
  • GETPreview the dependency impact of purging an archived dataset/api/v1/dataset/:uuid/purge-impactReport the charts and dashboards that depend on an archived dataset, with an impact token that must be echoed back on the purge request. Limited to owners and…
  • POSTRestore a soft-deleted dataset/api/v1/dataset/:uuid/restore

Datasources

  • GETList datasets and semantic views combined/api/v1/datasource/?q=
  • GETGet datasource metadata and capabilities/api/v1/datasource/:datasource_type/:datasource_id
  • GETGet possible values for a datasource column/api/v1/datasource/:datasource_type/:datasource_id/column/:column_name/values/?q=string&semantic_selection_version=string
  • POSTGet compatible metrics and dimensions/api/v1/datasource/:datasource_type/:datasource_id/compatible
  • POSTQuery a datasource by its semantic definitions/api/v1/datasource/:datasource_type/:datasource_id/query
  • POSTValidate a SQL expression against a datasource/api/v1/datasource/:datasource_type/:datasource_id/validate_expression/

Embedded Dashboard

  • GETGet a report schedule log/api/v1/embedded_dashboard/:uuid?uiConfig=0.0&show_filters=true&expand_filters=true&native_filters_key=string&permalink_key=string

Explore

  • GETAssemble Explore related information in a single endpoint/api/v1/explore/?form_data_key=string&permalink_key=string&slice_id=0&datasource_id=0&datasource_type=stringAssembles Explore related information (form_data, slice, dataset) in a single endpoint.<br/><br/> The information can be assembled from:<br/> - The cache…

Explore Form Data

  • POSTCreate a new form_data/api/v1/explore/form_data?tab_id=0
  • GETGet a form_data/api/v1/explore/form_data/:key
  • PUTUpdate an existing form_data/api/v1/explore/form_data/:key?tab_id=0
  • DELETEDelete a form_data/api/v1/explore/form_data/:key?tab_id=0

Explore Permanent Link

  • POSTCreate a new permanent link/api/v1/explore/permalink
  • GETGet chart's permanent link state/api/v1/explore/permalink/:key

LogRestApi

  • GETGet a list of logs/api/v1/log/?q=Gets a list of logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTPOST /api/v1/log//api/v1/log/
  • GETGet recent activity data for a user/api/v1/log/recent_activity/?q=
  • GETGet a log detail information/api/v1/log/:pk?q=Get an item model

Current User

  • GETGet the user object/api/v1/me/Gets the user object corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.
  • PUTUpdate the current user/api/v1/me/Updates the current user's first name, last name, or password.
  • GETGet the user roles/api/v1/me/roles/Gets the user roles corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.

Menu

  • GETGET /api/v1/menu//api/v1/menu/Get the menu data structure. Returns a forest like structure with the menu the user has access to

Queries

  • GETGet a list of queries/api/v1/query/?q=Gets a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • GETGet distinct values from field data/api/v1/query/distinct/:column_name?q=
  • GETGet related fields data/api/v1/query/related/:column_name?q=
  • POSTManually stop a query with client_id/api/v1/query/stop
  • GETGet a list of queries that changed after last_updated_ms/api/v1/query/updated_since?q=
  • GETGet query detail information/api/v1/query/:pk?q=Get an item model
  • GETGet a list of saved queries/api/v1/saved_query/?q=Gets a list of saved queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a saved query/api/v1/saved_query/
  • DELETEBulk delete saved queries/api/v1/saved_query/?q=
  • GETGet metadata information about this API resource/api/v1/saved_query/_info?q=Get metadata information about this API resource
  • GETGet distinct values from field data/api/v1/saved_query/distinct/:column_name?q=
  • GETDownload multiple saved queries as YAML files/api/v1/saved_query/export/?q=
  • POSTImport saved queries with associated databases/api/v1/saved_query/import/
  • GETGet related fields data/api/v1/saved_query/related/:column_name?q=
  • GETGet a saved query/api/v1/saved_query/:pk?q=Get an item model
  • PUTUpdate a saved query/api/v1/saved_query/:pk
  • DELETEDelete a saved query/api/v1/saved_query/:pk

Report Schedules

  • GETGet a list of report schedules/api/v1/report/?q=Gets a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a report schedule/api/v1/report/
  • DELETEBulk delete report schedules/api/v1/report/?q=
  • GETGet metadata information about this API resource/api/v1/report/_info?q=Get metadata information about this API resource
  • GETGet the global Alerts & Reports configuration/api/v1/report/configuration/Returns the values in effect for every setting: the stored value when an admin saved one, otherwise the legacy application config or feature flag fallback.
  • PUTUpdate the global Alerts & Reports configuration/api/v1/report/configuration/Admin only. Absent fields keep their value and null clears a field without restoring its legacy fallback. Recipient restrictions and minimum intervals are…
  • GETGet related fields data/api/v1/report/related/:column_name?q=
  • GETGet slack channels/api/v1/report/slack_channels/?q=Get slack channels
  • POSTSubscribe to a chart or dashboard report/api/v1/report/subscribeCreates a report schedule locked to the authenticated user's email. creation_method is derived server-side from the payload (chart → charts, dashboard →…
  • GETGet a report schedule/api/v1/report/:pk?q=Get an item model
  • PUTUpdate a report schedule/api/v1/report/:pk
  • DELETEDelete a report schedule/api/v1/report/:pk
  • POSTExecute a report schedule immediately/api/v1/report/:pk/execute
  • GETGet a list of report schedule logs/api/v1/report/:pk/log/?q=Gets a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • GETGet a report schedule log/api/v1/report/:pk/log/:log_id?q=

Row Level Security

  • GETGet a list of RLS/api/v1/rowlevelsecurity/?q=Gets a list of RLS, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a new RLS rule/api/v1/rowlevelsecurity/
  • DELETEBulk delete RLS rules/api/v1/rowlevelsecurity/?q=
  • GETGet metadata information about this API resource/api/v1/rowlevelsecurity/_info?q=Get metadata information about this API resource
  • GETGet related fields data/api/v1/rowlevelsecurity/related/:column_name?q=
  • GETGet an RLS/api/v1/rowlevelsecurity/:pk?q=Get an item model
  • PUTUpdate an RLS rule/api/v1/rowlevelsecurity/:pk
  • DELETEDelete an RLS/api/v1/rowlevelsecurity/:pk

Security

  • GETGet the CSRF token/api/v1/security/csrf_token/
  • POSTGet a guest token/api/v1/security/guest_token/
  • POSTPOST /api/v1/security/login/api/v1/security/loginAuthenticate and get a JWT access and refresh token
  • POSTRequest a password reset link/api/v1/security/password_recovery/Emails a single-use password reset link if the address belongs to an active account with a local password. The response is the same whether or not it does.
  • POSTReset a password with a recovery token/api/v1/security/password_recovery/reset/Consumes the single-use token from a password reset link and sets the account's new password. Every existing browser session for the account is signed out.
  • POSTPOST /api/v1/security/refresh/api/v1/security/refreshUse the refresh token to get a new JWT access token

Security Groups

  • GETGET /api/v1/security/groups//api/v1/security/groups/?q=Get a list of models
  • POSTPOST /api/v1/security/groups//api/v1/security/groups/
  • GETGET /api/v1/security/groups/_info/api/v1/security/groups/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/groups/{pk}/api/v1/security/groups/:pk?q=Get an item model
  • PUTPUT /api/v1/security/groups/{pk}/api/v1/security/groups/:pk
  • DELETEDELETE /api/v1/security/groups/{pk}/api/v1/security/groups/:pk

Security Permissions on Resources (View Menus)

  • GETGET /api/v1/security/permissions-resources//api/v1/security/permissions-resources/?q=Get a list of models
  • POSTPOST /api/v1/security/permissions-resources//api/v1/security/permissions-resources/
  • GETGET /api/v1/security/permissions-resources/_info/api/v1/security/permissions-resources/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/permissions-resources/{pk}/api/v1/security/permissions-resources/:pk?q=Get an item model
  • PUTPUT /api/v1/security/permissions-resources/{pk}/api/v1/security/permissions-resources/:pk
  • DELETEDELETE /api/v1/security/permissions-resources/{pk}/api/v1/security/permissions-resources/:pk

Security Permissions

  • GETGET /api/v1/security/permissions//api/v1/security/permissions/?q=Get a list of models
  • GETGET /api/v1/security/permissions/_info/api/v1/security/permissions/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/permissions/{pk}/api/v1/security/permissions/:pk?q=Get an item model

Security Resources (View Menus)

  • GETGET /api/v1/security/resources//api/v1/security/resources/?q=Get a list of models
  • POSTPOST /api/v1/security/resources//api/v1/security/resources/
  • GETGET /api/v1/security/resources/_info/api/v1/security/resources/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/resources/{pk}/api/v1/security/resources/:pk?q=Get an item model
  • PUTPUT /api/v1/security/resources/{pk}/api/v1/security/resources/:pk
  • DELETEDELETE /api/v1/security/resources/{pk}/api/v1/security/resources/:pk

Security Roles

  • GETGET /api/v1/security/roles//api/v1/security/roles/?q=Get a list of models
  • POSTPOST /api/v1/security/roles//api/v1/security/roles/
  • GETGET /api/v1/security/roles/_info/api/v1/security/roles/_info?q=Get metadata information about this API resource
  • GETList roles/api/v1/security/roles/search/?q={"filters":[{"col":"user_ids","value":"string"}],"order_column":"id","order_direction":"asc","page":0,"page_size":10}Fetch a paginated list of roles with user and permission IDs.
  • GETGET /api/v1/security/roles/{pk}/api/v1/security/roles/:pk?q=Get an item model
  • PUTPUT /api/v1/security/roles/{pk}/api/v1/security/roles/:pk
  • DELETEDELETE /api/v1/security/roles/{pk}/api/v1/security/roles/:pk
  • PUTPUT /api/v1/security/roles/{role_id}/groups/api/v1/security/roles/:role_id/groups
  • POSTPOST /api/v1/security/roles/{role_id}/permissions/api/v1/security/roles/:role_id/permissions
  • GETGET /api/v1/security/roles/{role_id}/permissions//api/v1/security/roles/:role_id/permissions/
  • PUTPUT /api/v1/security/roles/{role_id}/users/api/v1/security/roles/:role_id/users

Security Subjects

  • GETGet a list of Subjects/api/v1/security/subject/?q=Gets a list of Subjects, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • GETGet metadata information about this API resource/api/v1/security/subject/_info?q=Get metadata information about this API resource
  • GETGet a Subject/api/v1/security/subject/:pk?q=Get an item model

UserRegistrationsRestAPI

  • GETGET /api/v1/security/user_registrations//api/v1/security/user_registrations/?q=Get a list of models
  • GETGET /api/v1/security/user_registrations/_info/api/v1/security/user_registrations/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/user_registrations/{pk}/api/v1/security/user_registrations/:pk?q=Get an item model
  • DELETEDELETE /api/v1/security/user_registrations/{pk}/api/v1/security/user_registrations/:pk

Security Users

  • GETGET /api/v1/security/users//api/v1/security/users/?q=Get a list of models
  • POSTPOST /api/v1/security/users//api/v1/security/users/
  • GETGET /api/v1/security/users/_info/api/v1/security/users/_info?q=Get metadata information about this API resource
  • GETGET /api/v1/security/users/{pk}/api/v1/security/users/:pk?q=Get an item model
  • PUTPUT /api/v1/security/users/{pk}/api/v1/security/users/:pk
  • DELETEDELETE /api/v1/security/users/{pk}/api/v1/security/users/:pk
  • DELETEDELETE /api/v1/security/users/{pk}/sessions/api/v1/security/users/:pk/sessions

Semantic Layers

  • GETList all semantic layers/api/v1/semantic_layer/
  • POSTCreate a semantic layer/api/v1/semantic_layer/
  • GETList databases and semantic layers combined/api/v1/semantic_layer/connections/?q=
  • POSTGet configuration schema for a semantic layer type/api/v1/semantic_layer/schema/configuration
  • GETList available semantic layer types/api/v1/semantic_layer/types
  • GETGet a semantic layer by UUID/api/v1/semantic_layer/:uuid
  • PUTUpdate a semantic layer/api/v1/semantic_layer/:uuid
  • DELETEDelete a semantic layer/api/v1/semantic_layer/:uuid
  • POSTClear a semantic layer's cache/api/v1/semantic_layer/:uuid/clear_cache
  • POSTGet runtime schema for a semantic layer/api/v1/semantic_layer/:uuid/schema/runtime
  • POSTList available views from a semantic layer/api/v1/semantic_layer/:uuid/views

SemanticViewRestApi

  • POSTCreate semantic views/api/v1/semantic_view/
  • DELETEBulk delete semantic views/api/v1/semantic_view/?q=
  • PUTUpdate a semantic view/api/v1/semantic_view/:pk
  • DELETEDelete a semantic view/api/v1/semantic_view/:pk
  • GETGet semantic view structure/api/v1/semantic_view/:pk/structure

SQL Lab

  • GETGet the bootstrap data for SqlLab page/api/v1/sqllab/Assembles SQLLab bootstrap data (active_tab, databases, queries, tab_state_ids) in a single endpoint. The data can be assembled from the current user's id.
  • POSTEstimate the SQL query execution cost/api/v1/sqllab/estimate/
  • POSTExecute a SQL query/api/v1/sqllab/execute/
  • GETExport the SQL query results to a CSV/api/v1/sqllab/export/:client_id/
  • POSTExport SQL query results to CSV with streaming/api/v1/sqllab/export_streaming/
  • POSTFormat SQL code/api/v1/sqllab/format_sql/
  • GETGet the result of a SQL query execution/api/v1/sqllab/results/?q=

SQL Lab Permanent Link

  • POSTCreate a new permanent link/api/v1/sqllab/permalink
  • GETGet permanent link state for SQLLab editor./api/v1/sqllab/permalink/:key

Tags

  • GETGet a list of tags/api/v1/tag/?q=Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
  • POSTCreate a tag/api/v1/tag/Create a new Tag

Showing 300 of 329 endpoints. Fork the collection to see all of them.

API details

Base URL
http://localhost:8088
Authentication
A bearer token in the Authorization header
A bearer token in the Authorization header
A bearer token in the Authorization header
Operations
329 operations on 251 pathsGET 167POST 84DELETE 44PUT 34
Main resources
Dashboards 37Database 33Datasets 28Charts 27Queries 17Report Schedules 15Tags 15Themes 15Annotation Layers 14Security Roles 11
Response formats
application/json application/zip image/* text/csv
Description format
OpenAPI 3.0.2, API version v1

How to test the Superset in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Superset collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Return an AdvancedDataTypeResponse” (GET /api/v1/advanced_data_type/convert?q=), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Superset?

Superset It is listed under Data & analytics and has 329 endpoints.

Who publishes the Superset?

It is listed from Apache's public API description (an OpenAPI document), not published by Apache on Swastik Codes. Anyone who controls apache.org can claim the profile by adding a DNS TXT record.

What is the base URL of the Superset?

Requests go to http://localhost:8088. Endpoint paths are added to this base URL.

How do I authenticate with the Superset?

It accepts 3 methods: A bearer token in the Authorization header; A bearer token in the Authorization header; A bearer token in the Authorization header.

How many endpoints does the Superset have?

329 operations on 251 paths (167 GET, 84 POST, 44 DELETE, 34 PUT). The largest groups are Dashboards, Database, Datasets, Charts.

Is forking the Superset free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.