Data tables

Update a data table

Updates which fields (columns) of the data table are selected for delivery. selected_fields must contain the full list of field name values (as returned by the detail endpoint's fields[].name) that should be selected — any field not listed becomes deselected. Field selection is set at the data table level and affects all loads delivering this data table. Unknown field names are ignored. Dimension fields cannot be deselected — omitting a dimension field from selected_fields returns 400. Fields the detail endpoint returns with can_edit: false are not meant to be toggled and should always be included in selected_fields.

put/api/v3/data-tables/{data_table_id}

Request

Path parameters

data_table_idinteger required

Data Table ID

Request body

selected_fieldsstring[] required

Full list of field name values that should be selected. Any field of the data table not listed becomes deselected.

Response

Update a Data Table

titlestring

Data Table title

freshnessstring

Data Table freshness date

datasource_namestring

Data source name

report_typestring

Report type

data_classstring

Data class

workspaceinteger

Workspace ID

sql_namestring

SQL name

auto_extract_new_accountsboolean

Auto extract new accounts

Example response

{
  "data_table_1": {
    "value": {
      "title": "Table 1",
      "freshness": "2021-01-01T00:00:00Z",
      "data_source": "google_ads",
      "report_type": "report",
      "data_class": "daily",
      "workspace": 1,
      "sql_name": "report_123_google_ads",
      "auto_extract_new_accounts": true,
      "fields": {
        "field_1": {
          "kind": "dimension",
          "title": "Field 1",
          "sql_name": "field_1",
          "field_type": "string",
          "format": "string",
          "is_dynamic": false,
          "is_selected": true
        },
        "field_2": {
          "kind": "dimension",
          "title": "Field 2",
          "sql_name": "field_2",
          "field_type": "string",
          "format": "string",
          "is_dynamic": false,
          "is_selected": true
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.