looker-node-api v3.1.7

looker-node-api

LookerApi31Reference - JavaScript client for looker-node-api

Authorization

The Looker API uses Looker API3 credentials for authorization and access control. Looker admins can create API3 credentials on Looker's Admin/Users page. Pass API3 credentials to the _/login endpoint to obtain a temporary access_token. Include that access_token in the Authorization header of Looker API requests. For details, see Looker API Authorization

Client SDKs

The Looker API is a RESTful system that should be usable by any programming language capable of making HTTPS requests. Client SDKs for a variety of programming languages can be generated from the Looker API's Swagger JSON metadata to streamline use of the Looker API in your applications. A client SDK for Ruby is available as an example. For more information, see Looker API Client SDKs

Try It Out!

The 'api-docs' page served by the Looker instance includes 'Try It Out!' buttons for each API method. After logging in with API3 credentials, you can use the \"Try It Out!\" buttons to call the API directly from the documentation page to interactively explore API features and responses. Note! With great power comes great responsibility: The \"Try It Out!\" button makes API calls to your live Looker instance. Be especially careful with destructive API operations such as delete_user or similar. There is no \"undo\" for API operations.

Versioning

Future releases of Looker will expand this API release-by-release to securely expose more and more of the core power of Looker to API client applications. API endpoints marked as \"beta\" may receive breaking changes without warning (but we will try to avoid doing that). Stable (non-beta) API endpoints should not receive breaking changes in future releases. For more information, see Looker API Versioning This API 3.1 is in active development. This is where support for new Looker features will appear as non-breaking additions - new functions, new optional parameters on existing functions, or new optional properties in existing types. Additive changes should not impact your existing application code that calls the Looker API. Your existing application code will not be aware of any new Looker API functionality until you choose to upgrade your app to use a newer Looker API client SDK release. The following are a few examples of noteworthy items that have changed between API 3.0 and API 3.1. For more comprehensive coverage of API changes, please see the release notes for your Looker release.

Examples of new things added in API 3.1:

• Dashboard construction APIs
• Themes and custom color collections APIs
• Create and run SQL_runner queries
• Create and run merged results queries
• Create and modify dashboard filters
• Create and modify password requirements

Deprecated in API 3.0

The following functions and properties have been deprecated in API 3.0. They continue to exist and work in API 3.0 for the next several Looker releases but they have not been carried forward to API 3.1:

• Dashboard Prefetch functions
• User access_filter functions
• User API 1.0 credentials functions
• Space.is_root and Space.is_user_root properties. Use Space.is_shared_root and Space.is_users_root instead.

Semantic changes in API 3.1:

• all_looks no longer includes soft-deleted looks, matching all_dashboards behavior. You can find soft-deleted looks using search_looks with the deleted param set to True.
• all_spaces no longer includes duplicate items
• search_users no longer accepts Y,y,1,0,N,n for Boolean params, only \"true\" and \"false\".
• For greater client and network compatibility, render_task_results now returns HTTP status 202 Accepted instead of HTTP status 102 Processing
• all_running_queries and kill_query functions have moved into the Query function group. If you have application code which relies on the old behavior of the APIs above, you may continue using the API 3.0 functions in this Looker release. We strongly suggest you update your code to use API 3.1 analogs as soon as possible.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.1.0
• Package version: 3.1.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://looker.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install looker-node-api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your looker-node-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('looker-node-api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/looker-node-api then install it via:

    npm install YOUR_USERNAME/looker-node-api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LookerApi31Reference = require('looker-node-api');

var api = new LookerApi31Reference.ApiAuthApi()

var opts = {
  'clientId': "clientId_example", // {String} client_id part of API3 Key.
  'clientSecret': "clientSecret_example" // {String} client_secret part of API3 Key.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(opts, callback);

Documentation for API Endpoints

All URIs are relative to /api/3.1

Documentation for Models

• LookerApi31Reference.AccessToken
• LookerApi31Reference.ApiSession
• LookerApi31Reference.ApiVersion
• LookerApi31Reference.ApiVersionElement
• LookerApi31Reference.BackupConfiguration
• LookerApi31Reference.ColorCollection
• LookerApi31Reference.ColorStop
• LookerApi31Reference.ContentFavorite
• LookerApi31Reference.ContentMeta
• LookerApi31Reference.ContentMetaGroupUser
• LookerApi31Reference.ContentValidation
• LookerApi31Reference.ContentValidationDashboard
• LookerApi31Reference.ContentValidationDashboardElement
• LookerApi31Reference.ContentValidationDashboardFilter
• LookerApi31Reference.ContentValidationLook
• LookerApi31Reference.ContentValidationSpace
• LookerApi31Reference.ContentValidatorError
• LookerApi31Reference.ContentView
• LookerApi31Reference.ContinuousPalette
• LookerApi31Reference.CreateDashboardFilter
• LookerApi31Reference.CreateDashboardRenderTask
• LookerApi31Reference.CreateQueryTask
• LookerApi31Reference.CredentialsApi3
• LookerApi31Reference.CredentialsEmail
• LookerApi31Reference.CredentialsEmbed
• LookerApi31Reference.CredentialsGoogle
• LookerApi31Reference.CredentialsLDAP
• LookerApi31Reference.CredentialsLookerOpenid
• LookerApi31Reference.CredentialsOIDC
• LookerApi31Reference.CredentialsSaml
• LookerApi31Reference.CredentialsTotp
• LookerApi31Reference.DBConnection
• LookerApi31Reference.DBConnectionBase
• LookerApi31Reference.DBConnectionOverride
• LookerApi31Reference.DBConnectionTestResult
• LookerApi31Reference.Dashboard
• LookerApi31Reference.DashboardBase
• LookerApi31Reference.DashboardElement
• LookerApi31Reference.DashboardFilter
• LookerApi31Reference.DashboardLayout
• LookerApi31Reference.DashboardLayoutComponent
• LookerApi31Reference.DataActionForm
• LookerApi31Reference.DataActionFormField
• LookerApi31Reference.DataActionFormSelectOption
• LookerApi31Reference.DataActionRequest
• LookerApi31Reference.DataActionResponse
• LookerApi31Reference.DataActionUserState
• LookerApi31Reference.Datagroup
• LookerApi31Reference.Dialect
• LookerApi31Reference.DialectInfo
• LookerApi31Reference.DialectInfoOptions
• LookerApi31Reference.DiscretePalette
• LookerApi31Reference.Error
• LookerApi31Reference.Folder
• LookerApi31Reference.GitBranch
• LookerApi31Reference.GitConnectionTest
• LookerApi31Reference.GitConnectionTestResult
• LookerApi31Reference.GitStatus
• LookerApi31Reference.Group
• LookerApi31Reference.GroupIdForGroupInclusion
• LookerApi31Reference.GroupIdForGroupUserInclusion
• LookerApi31Reference.Homepage
• LookerApi31Reference.HomepageItem
• LookerApi31Reference.HomepageSection
• LookerApi31Reference.ImportedProject
• LookerApi31Reference.Integration
• LookerApi31Reference.IntegrationHub
• LookerApi31Reference.IntegrationParam
• LookerApi31Reference.IntegrationRequiredField
• LookerApi31Reference.IntegrationTestResult
• LookerApi31Reference.LDAPConfig
• LookerApi31Reference.LDAPConfigTestIssue
• LookerApi31Reference.LDAPConfigTestResult
• LookerApi31Reference.LDAPGroupRead
• LookerApi31Reference.LDAPGroupWrite
• LookerApi31Reference.LDAPUser
• LookerApi31Reference.LDAPUserAttributeRead
• LookerApi31Reference.LDAPUserAttributeWrite
• LookerApi31Reference.LegacyFeature
• LookerApi31Reference.Locale
• LookerApi31Reference.LocalizationSettings
• LookerApi31Reference.Look
• LookerApi31Reference.LookBasic
• LookerApi31Reference.LookModel
• LookerApi31Reference.LookWithDashboards
• LookerApi31Reference.LookWithQuery
• LookerApi31Reference.LookmlModel
• LookerApi31Reference.LookmlModelExplore
• LookerApi31Reference.LookmlModelExploreAccessFilter
• LookerApi31Reference.LookmlModelExploreAlias
• LookerApi31Reference.LookmlModelExploreAlwaysFilter
• LookerApi31Reference.LookmlModelExploreConditionallyFilter
• LookerApi31Reference.LookmlModelExploreError
• LookerApi31Reference.LookmlModelExploreField
• LookerApi31Reference.LookmlModelExploreFieldEnumeration
• LookerApi31Reference.LookmlModelExploreFieldMapLayer
• LookerApi31Reference.LookmlModelExploreFieldSqlCase
• LookerApi31Reference.LookmlModelExploreFieldTimeInterval
• LookerApi31Reference.LookmlModelExploreFieldset(docs/Loo