Getting started with Looker

Best Practices

Documentation

Community

Training

Certification

Articles in this section

See more

Migration from API 3.0 to 3.1: Change Log & Notes

Avatar
Tig Newman
  • Updated
Follow

Starting in Looker 6.12, the default API version is 3.1 and new features will appear only in API 3.1.

What Happens to API 3.0?

API 3.0 is considered "legacy," meaning that Looker does not plan to make any further changes to API 3.0 endpoints or data types. If a security issue is discovered which requires making API updates, we will make changes to API 3.0 (and 3.1) to address the security issue. But beyond that, API 3.0 is "frozen."

API 3.0 will be available for many Looker releases, so that your existing application code that uses Looker API 3.0 will continue to run uninterrupted. If and when actually removing API 3.0 becomes necessary, we will communicate the timeline to our users well in advance of any change in API 3.0 availability

Why and How Do I Migrate to API 3.1?

It is best to migrate your code for use with API 3.1. This lets you take advantage of new functionality in API 3.1 currently and functionality that will be added in future releases.

In many cases, migrating to 3.1 requires only a review of your application code, with very few actual changes. See the API Versioning documentation page for guidelines on migrating application code to use a new Looker API version.

Changes in API 3.1 

The following sections list the changes from API 3.0 to API 3.1, including removed elements, updated elements, and new elements.

What Was Removed in API 3.1?

The following API 3.0 elements were removed in API 3.1. (These elements have all been deprecated in API 3.0 for quite some time.)

Functions/Endpoints

Data Types

  • AccessFilter

  • CredentialsApi

  • Prefetch

  • PrefetchAccessFilterValue

  • PrefetchDashboardFilterValue

  • PrefetchDashboardRequest

Properties in Data Types

Space, SpaceBase

  • is_root replaced by is_shared_root

  • is_user_root replaced by is_users_root

User

  • access_filters
  • credentials_api

What Was Changed in API 3.1?

The following API 3.0 elements are updated in API 3.1:
  • create_sql_query and sql_query functions are now located in the Query function group instead of SqlQuery group.
  • schedule_plan endpoints now accept an all_users boolean param to return schedule plans for all users, not just schedule plans of the caller.

What is New in API 3.1? 

As of Looker 6.12, the following elements were added in API 3.1. We will continue to add new elements beyond this list. Any further updates will be included in the Looker Release Notes.

Functions/Endpoints

Color Collections

  • all_color_collections
  • create_color_collection
  • color_collection
  • delete_color_collection
  • update_color_collection
  • color_collections_custom
  • default_color_collection
  • set_default_color_collection
  • color_collections_standard
  • content_validation
Dashboards
  • create_dashboard_element
  • delete_dashboard_element
  • dashboard_element
  • update_dashboard_element
  • search_dashboard_elements
  • create_dashboard_filter
  • delete_dashboard_filter
  • dashboard_filter
  • update_dashboard_filter
  • dashboard_layout_component
  • update_dashboard_layout_component
  • create_dashboard_layout
  • delete_dashboard_layout
  • dashboard_layout
  • update_dashboard_layout
  • dashboard_layout_dashboard_layout_components
  • dashboard_dashboard_elements
  • dashboard_dashboard_filters
  • dashboard_dashboard_layouts

Homepage

  • all_homepages
  • create_homepage
  • delete_homepage
  • homepage
  • update_homepage
  • search_homepages

Configuration

  • all_locales

Query

  • create_merge_query
  • merge_query
  • run_sql_query

User Authentication

  • password_config
  • update_password_config
  • force_password_reset_at_next_login_for_all_users
  • session_config
  • update_session_config

Project

  • delete_repository_credential
  • update_repository_credential
  • get_all_repository_credentials

Themes

  • all_themes
  • create_theme
  • delete_theme
  • theme
  • update_theme
  • active_themes
  • default_theme
  • set_default_theme
  • search_themes
  • theme_or_default
  • validate_theme

Data Types:

  • ColorCollection
  • ColorStop
  • ContentValidation
  • ContentValidationDashboard
  • ContentValidationDashboardElement
  • ContentValidationDashboardFilter
  • ContentValidationLook
  • ContentValidationSpace
  • ContentValidationError
  • ContinuousPalette
  • CreateDashboardFilter
  • DiscretePalette
  • Homepage
  • Locale
  • MergeFields
  • MergeQuery
  • MergeQuerySourceQuery
  • PasswordConfig
  • RepositoryCredential
  • SessionConfig
  • Theme
  • ThemeSettings
 

 

Related articles