Mode

Mode Datasets API

The Datasets API from Mode — 8 operation(s) for datasets.

Documentation GitHub OpenAPI

Operations 13

GET /{account}/datasets/{dataset}/fields Get fields for a Dataset #

GET /{account}/datasets/{dataset}/field_descriptions Get field descriptions for a Dataset #

POST /{account}/datasets/{dataset}/field_descriptions Create a field description for a Dataset #

PATCH /{account}/datasets/{dataset}/field_descriptions/{field_description} Update a field description for a Dataset #

DELETE /{account}/datasets/{dataset}/field_descriptions/{field_description} Delete a field description for a Dataset #

PATCH /{account}/datasets/{dataset} Update a Dataset #

GET /{account}/datasets/{dataset} Get a Dataset #

DELETE /{account}/datasets/{dataset} Delete a Dataset #

GET /{account}/datasets/{dataset}/reports List Reports using a Dataset #

POST /{account}/datasets/{dataset}/runs Create a Dataset run #

GET /{account}/datasets/{dataset}/runs List Dataset runs #

GET /{workspace}/datasets/{dataset}/schedules List schedules for a dataset #

GET /{account}/datasets/{dataset}/runs/{run} Get a Dataset run #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/mode/refs/heads/main/openapi/mode-datasets-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mode-datasets-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 0.0.1
  title: Mode Account Datasets API
  description: 'Mode provides a REST API for many common operations, such as:


    * Listing spaces and reports

    * Running reports

    * Downloading query results


    ## Authentication


    For most Mode API calls, the client must supply an API token and secret for

    HTTP basic authentication.


    If authentication is required for a given resource, unauthenticated requests

    will result in a `401 Unauthorized` response.


    [Create and Manage API Tokens](https://modeanalytics.com/settings/access_tokens)

    '
  termsOfService: https://mode.com/tos/
  contact:
    name: Mode API Team
    email: support@modeanalytics.com
  license:
    name: MIT
servers:
- url: https://modeanalytics.com/api
security:
- accessTokenAuth: []
tags:
- name: Datasets
paths:
  /{account}/datasets/{dataset}/fields:
    x-summary: Dataset Field Descriptions
    get:
      operationId: getDatasetFields
      summary: Get fields for a Dataset
      description: Returns a list of the latest fields for a `Dataset`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '200':
          description: '`DatasetField` collection response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetFields'
      tags:
      - Datasets
  /{account}/datasets/{dataset}/field_descriptions:
    x-summary: Dataset Field Descriptions
    get:
      operationId: getDatasetFieldDescriptions
      summary: Get field descriptions for a Dataset
      description: Returns a list of field descriptions for a `Dataset`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '200':
          description: '`DatasetFieldDescriptions` collection response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetFieldDescriptions'
      tags:
      - Datasets
    post:
      operationId: createDatasetFieldDescriptions
      summary: Create a field description for a Dataset
      description: Create a field description for a `Dataset` with the provided parameters
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '200':
          description: '`DatasetFieldDescription` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetFieldDescription'
      tags:
      - Datasets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetFieldDescriptionBody'
        description: Dataset field description parameters
        required: true
  /{account}/datasets/{dataset}/field_descriptions/{field_description}:
    x-summary: Dataset Field Descriptions
    patch:
      operationId: updateDatasetFieldDescription
      summary: Update a field description for a Dataset
      description: Updates a field description for a `Dataset` with the provided parameters
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      - name: field description
        in: path
        description: '`DatasetFieldDescription` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`DatasetFieldDescription` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '200':
          description: '`DatasetFieldDescription` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetFieldDescription'
      tags:
      - Datasets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetFieldDescriptionBody'
        description: Dataset field description parameters
        required: true
    delete:
      operationId: deleteDatasetFieldDescription
      summary: Delete a field description for a Dataset
      description: Deletes a field description for a `Dataset`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      - name: field description
        in: path
        description: '`DatasetFieldDescription` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`DatasetFieldDescription` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '200':
          description: '`DatasetFieldDescription` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetFieldDescription'
      tags:
      - Datasets
  /{account}/datasets/{dataset}:
    x-summary: Dataset
    patch:
      operationId: updateDataset
      summary: Update a Dataset
      description: Updates a single `Dataset` with the provided attributes
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '200':
          description: '`Dataset` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Report'
      tags:
      - Datasets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReportRequestBody'
    get:
      operationId: getDataset
      summary: Get a Dataset
      description: Returns a representation of a single `Dataset`
      responses:
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '200':
          description: '`Dataset` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Report'
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      tags:
      - Datasets
    delete:
      operationId: deleteDataset
      summary: Delete a Dataset
      description: Deletes a single `Dataset`
      responses:
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '200':
          description: Empty body
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      tags:
      - Datasets
  /{account}/datasets/{dataset}/reports:
    x-summary: Dataset
    get:
      operationId: getDatasetReports
      summary: List Reports using a Dataset
      description: Returns a list of reports that have imported the `Dataset`
      responses:
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '200':
          description: '`Report` collection response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Reports'
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      tags:
      - Datasets
  /{account}/datasets/{dataset}/runs:
    x-summary: Dataset Runs
    post:
      operationId: runDataset
      summary: Create a Dataset run
      description: Runs a single `Dataset` and returns a representation of the resulting `DatasetRun`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '202':
          description: '`DatasetRun` Accepted'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetRun'
      tags:
      - Datasets
    get:
      operationId: listDatasetRuns
      summary: List Dataset runs
      description: Returns a list of `DatasetRun`s for a `Dataset`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: 'Returns a filtered list of `Run`s for a `Dataset` filtered by whether their `created_at` or `updated_at` timestamps are `gt` (greater than) or `lt` (less than) the datetime passed in ISO8601 format. Example: `?filter=updated_at.lt.2019-10-23T06:23:01Z` returns all `Runs` in a space created before that date.'
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: With the `order` param, returns all `DatasetRun`s for a `Dataset` ordered by their `created_at` or `updated_at` timestamps
        required: false
        schema:
          type: string
      - name: order_by
        in: query
        description: With the `order_by` param, returns all `DatasetRun`s for a `Dataset` ordered in `asc` or `desc` order
        required: false
        schema:
          type: string
      responses:
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '200':
          description: '`DatasetRun` collection response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ReportRuns'
      tags:
      - Datasets
  /{workspace}/datasets/{dataset}/schedules:
    x-summary: DatasetSchedules
    get:
      operationId: listDatasetSchedules
      summary: List schedules for a dataset
      description: Returns all `Schedule`s for a `Dataset`
      responses:
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: '`Dataset` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '200':
          description: Dataset `Schedule` collection response
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DatasetSchedules'
      parameters:
      - name: workspace
        in: path
        description: '`Workspace` username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      tags:
      - Datasets
  /{account}/datasets/{dataset}/runs/{run}:
    x-summary: Dataset Run
    get:
      operationId: getDatasetRun
      summary: Get a Dataset run
      description: Returns a representation of a single `DatasetRun`
      parameters:
      - name: account
        in: path
        description: '`Account` (`Workspace` or `User`) username'
        required: true
        schema:
          type: string
      - name: dataset
        in: path
        description: '`Dataset` token'
        required: true
        schema:
          type: string
      - name: run
        in: path
        description: '`DatasetRun` token'
        required: true
        schema:
          type: string
      responses:
        '404':
          description: '`DatasetRun` not found'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '401':
          description: Unauthorized
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '200':
          description: '`DatasetRun` response'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ReportRun'
      tags:
      - Datasets
components:
  schemas:
    DatasetRunLinks:
      properties:
        self:
          $ref: '#/components/schemas/Link'
        account:
          $ref: '#/components/schemas/Link'
        executed_by:
          $ref: '#/components/schemas/Link'
        latest_successful_dataset_run_api_url:
          $ref: '#/components/schemas/Link'
        dataset:
          $ref: '#/components/schemas/Link'
        query_runs:
          $ref: '#/components/schemas/Link'
        share:
          $ref: '#/components/schemas/Link'
      required:
      - self
      - account
      - dataset
      - query_runs
    ReportRun:
      properties:
        token:
          type: string
        state:
          enum:
          - pending
          - enqueued
          - cancelled
          - failed
          - succeeded
          - completed
          - running_notebook
          type: string
        parameters:
          $ref: '#/components/schemas/ReportRunParameters'
        created_at:
          type: string
        updated_at:
          type: string
        completed_at:
          type: string
        purge_started_at:
          type: string
        purge_completed_at:
          type: string
        python_state:
          enum:
          - none
          - pending
          - failed
          - submitted
          - succeeded
          type: string
        form_fields:
          type: array
        is_latest_report_run:
          type: string
        is_latest_successful_report_run:
          type: string
        report_has_failures_since_last_success:
          type: string
        pusher_channel_name:
          type: string
        _links:
          $ref: '#/components/schemas/ReportRunLinks'
        _embedded:
          $ref: '#/components/schemas/ReportRunEmbeds'
      required:
      - _links
      - token
      - state
      - created_at
      - updated_at
      - completed_at
      - purge_started_at
      - purge_completed_at
      - is_latest_report_run
      - is_latest_successful_report_run
      - report_has_failures_since_last_success
    ReportRuns:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        _links:
          $ref: '#/components/schemas/ReportRunsLinks'
        _embedded:
          $ref: '#/components/schemas/ReportRunsEmbeds'
      required:
      - _links
    BadRequest:
      required:
      - id
      - message
      properties:
        id:
          type: string
          enum:
          - bad_request
        message:
          type: string
    ReportRunParameters: {}
    Unauthorized:
      required:
      - id
      - message
      properties:
        id:
          type: string
          enum:
          - unauthorized
        message:
          type: string
    CreateDatasetFieldDescriptionBody:
      required:
      - field_description
      type: object
      properties:
        field_description:
          type: object
          description: The parameters for updating the field description
          properties:
            desc:
              description: The description of the field
              type: string
            name:
              description: The name of the field
              type: string
    ReportEmbeds: {}
    Reports:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        _links:
          $ref: '#/components/schemas/ReportsLinks'
        _embedded:
          $ref: '#/components/schemas/ReportsEmbeds'
      required:
      - _links
    ReportsLinks:
      properties:
        next_page:
          $ref: '#/components/schemas/Link'
        prev_page:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
      required:
      - self
    NotFound:
      required:
      - id
      - message
      properties:
        id:
          type: string
          enum:
          - not_found
        message:
          type: string
    ReportRunEmbeds: {}
    ReportRunsLinks:
      properties:
        next_page:
          $ref: '#/components/schemas/Link'
        prev_page:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
      required:
      - self
    Report:
      properties:
        token:
          type: string
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        published_at:
          type: string
        edited_at:
          type: string
        theme_id:
          type: integer
        color_mappings:
          type: string
        type:
          type: string
        last_successful_sync_at:
          type: string
        last_saved_at:
          type: string
        archived:
          type: boolean
        space_token:
          type: string
        account_id:
          type: integer
        account_username:
          type: string
        public:
          type: boolean
        full_width:
          type: boolean
        manual_run_disabled:
          type: boolean
        drill_anywhere_enabled:
          type: boolean
        run_privately:
          type: boolean
        drilldowns_enabled:
          type: boolean
        layout:
          type: string
        is_embedded:
          type: boolean
        is_signed:
          type: boolean
        imported_datasets:
          type: string
        shared:
          type: boolean
        expected_runtime:
          type: number
        last_successfully_run_at:
          type: string
        last_run_at:
          type: string
        web_preview_image:
          type: string
        last_successful_run_token:
          type: string
        github_link:
          type: string
        query_count:
          type: string
        max_query_count:
          type: string
        chart_count:
          type: string
        runs_count:
          type: string
        schedules_count:
          type: string
        query_preview:
          type: string
        view_count:
          type: string
        thoughtspot_published_at:
          type: string
        _links:
          $ref: '#/components/schemas/ReportLinks'
        _embedded:
          $ref: '#/components/schemas/ReportEmbeds'
      required:
      - _links
      - token
      - id
      - name
      - created_at
      - updated_at
      - published_at
      - edited_at
      - type
      - last_successful_sync_at
      - last_saved_at
      - archived
      - account_id
      - account_username
      - public
      - manual_run_disabled
      - drill_anywhere_enabled
      - run_privately
      - drilldowns_enabled
      - expected_runtime
      - last_successfully_run_at
      - last_run_at
      - last_successful_run_token
      - query_count
      - max_query_count
      - runs_count
      - schedules_count
      - query_preview
      - view_count
      - thoughtspot_published_at
    UpdateReportRequestBody:
      required:
      - report
      type: object
      properties:
        report:
          type: object
          properties:
            name:
              type: string
              description: The name of the report
              example: Kanto Region Diaspora
            description:
              type: string
              description: A description of the report in question
              example: An analysis of all the creatures living in the region. Please contribute any missing data. Pocket version coming soon.
            space_token:
              type: string
              description: The token of the space this report will be moved to
              example: 5a4177a2902c
    DatasetRunEmbeds: {}
    Link:
      required:
      - href
      properties:
        href:
          type: string
        templated:
          type: boolean
          default: false
    Pagination:
      required:
      - first_page
      - last_page
      - total_pages
      - total_count
      properties:
        first_page:
          type: string
        last_page:
          type: string
        total_pages:
          type: integer
        total_count:
          type: integer
    ReportRunsEmbeds: {}
    ReportLinks:
      properties:
        self:
          $ref: '#/components/schemas/Link'
        web:
          $ref: '#/components/schemas/Link'
        web_edit:
          $ref: '#/components/schemas/Link'
        web_external_url:
          $ref: '#/components/schemas/Link'
        csv_export:
          $ref: '#/components/schemas/Link'
        share:
          $ref: '#/components/schemas/Link'
        web_report_runs:
          $ref: '#/components/schemas/Link'
        account:
          $ref: '#/components/schemas/Link'
        report_run:
          $ref: '#/components/schemas/Link'
        star:
          $ref: '#/components/schemas/Link'
        space:
          $ref: '#/components/schemas/Link'
        space_links:
          $ref: '#/components/schemas/Link'
        queries:
          $ref: '#/components/schemas/Link'
        report_runs:
          $ref: '#/components/schemas/Link'
        report_pins:
          $ref: '#/components/schemas/Link'
        report_filters:
          $ref: '#/components/schemas/Link'
        report_schedules:
          $ref: '#/components/schemas/Link'
        report_subscriptions:
          $ref: '#/components/schemas/Link'
        dataset_dependencies:
          $ref: '#/components/schemas/Link'
        python_visualizations:
          $ref: '#/components/schemas/Link'
        embed_key:
          $ref: '#/components/schemas/Link'
        last_run:
          $ref: '#/components/schemas/Link'
        last_successful_run:
          $ref: '#/components/schemas/Link'
        python_notebook:
          $ref: '#/components/schemas/Link'
        perspective_email_subscription_memberships:
          $ref: '#/components/schemas/Link'
        validate_email_subscriber:
          $ref: '#/components/schemas/Link'
        creator:
          $ref: '#/components/schemas/Link'
        report_theme:
          $ref: '#/components/schemas/Link'
        last_successful_github_sync:
          $ref: '#/components/schemas/Link'
        report_index_web:
          $ref: '#/components/schemas/Link'
        dbt_metadata:
          $ref: '#/components/schemas/Link'
      required:
      - self
      - web
      - account
      - report_run
      - queries
      - report_runs
      - report_pins
      - report_schedules
      - last_run
      - last_successful_run
      - perspective_email_subscription_memberships
      - last_successful_github_sync
    ReportsEmbeds: {}
    UpdateDatasetFieldDescriptionBody:
      required:
      - field_description
      type: object
      properties:
        field_description:
          type: object
          description: The parameters for updating the field description
          properties:
            desc:
              description: The description of the field
              type: string
    DatasetRun:
      properties:
        created_at:
          type: string
        completed_at:
          type: string
        is_latest_dataset_run:
          type: string
        is_latest_successful_dataset_run:
          type: string
        purge_completed_at:
          type: string
        purge_started_at:
          type: string
        dataset_has_failures_since_last_success:
          type: string
        state:
          enum:
          - pending
          - enqueued
          - cancelled
          - failed
          - succeeded
          - completed
          type: string
        token:
          type: string
        updated_at:
          type: string
        pusher_channel_name:
          type: string
        _links:
          $ref: '#/components/schemas/DatasetRunLinks'
        _embedded:
          $ref: '#/components/schemas/DatasetRunEmbeds'
      required:
      - _links
      - created_at
      - completed_at
      - is_latest_dataset_run
      - is_latest_successful_dataset_run
      - purge_completed_at
      - purge_started_at
      - dataset_has_failures_since_last_success
      - state
      - token
      - updated_at
    ReportRunLinks:
      properties:
        latest_successful_report_run_api_url:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
        content:
          $ref: '#/components/schemas/Link'
        preview:
          $ref: '#/components/schemas/Link'
        account:
          $ref: '#/components/schemas/Link'
        report_schedule:
          $ref: '#/components/schemas/Link'
        executed_by:
          $ref: '#/components/schemas/Link'
        share:
          $ref: '#/components/schemas/Link'
        embed:
          $ref: '#/components/schemas/Link'
        report:
          $ref: '#/components/schemas/Link'
        clone:
          $ref: '#/components/schemas/Link'
        query_runs:
          $ref: '#/components/schemas/Link'
        python_cell_runs:
          $ref: '#/components/schemas/Link'
        pdf_export:
          $ref: '#/components/schemas/Link'
        web_edit_dataset:
          $ref: '#/components/schemas/Link'
        web_clone:
          $ref: '#/components/schemas/Link'
        web_external_url:
          $ref: '#/components/schemas/Link'
      required:
      - self
      - account
      - report
      - query_runs
  securitySchemes:
    accessTokenAuth:
      type: http
      scheme: basic