lookerjs v1.0.0

looker_api_30_reference

LookerApi30Reference - JavaScript client for looker_api_30_reference

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. ### 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. Stable (non-beta) API endpoints should not receive breaking changes in future releases. For more information, see Looker API Versioning

This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.0.0
• Package version: 3.0.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_api_30_reference --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_api_30_reference from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('looker_api_30_reference') 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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 LookerApi30Reference = require('looker_api_30_reference');

var api = new LookerApi30Reference.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 https://newwave.looker.com:19999/api/3.0

Documentation for Models

• LookerApi30Reference.AccessFilter
• LookerApi30Reference.AccessToken
• LookerApi30Reference.ApiSession
• LookerApi30Reference.ApiVersion
• LookerApi30Reference.ApiVersionElement
• LookerApi30Reference.BackupConfiguration
• LookerApi30Reference.ContentFavorite
• LookerApi30Reference.ContentMeta
• LookerApi30Reference.ContentMetaGroupUser
• LookerApi30Reference.ContentView
• LookerApi30Reference.CreateDashboardRenderTask
• LookerApi30Reference.CreateQueryTask
• LookerApi30Reference.CredentialsApi
• LookerApi30Reference.CredentialsApi3
• LookerApi30Reference.CredentialsEmail
• LookerApi30Reference.CredentialsEmbed
• LookerApi30Reference.CredentialsGoogle
• LookerApi30Reference.CredentialsLDAP
• LookerApi30Reference.CredentialsLookerOpenid
• LookerApi30Reference.CredentialsOIDC
• LookerApi30Reference.CredentialsSaml
• LookerApi30Reference.CredentialsTotp
• LookerApi30Reference.DBConnection
• LookerApi30Reference.DBConnectionBase
• LookerApi30Reference.DBConnectionOverride
• LookerApi30Reference.DBConnectionTestResult
• LookerApi30Reference.Dashboard
• LookerApi30Reference.DashboardBase
• LookerApi30Reference.DashboardElement
• LookerApi30Reference.DashboardFilter
• LookerApi30Reference.DashboardLayout
• LookerApi30Reference.DashboardLayoutComponent
• LookerApi30Reference.DataActionForm
• LookerApi30Reference.DataActionFormField
• LookerApi30Reference.DataActionFormSelectOption
• LookerApi30Reference.DataActionRequest
• LookerApi30Reference.DataActionResponse
• LookerApi30Reference.DataActionUserState
• LookerApi30Reference.Datagroup
• LookerApi30Reference.Dialect
• LookerApi30Reference.DialectInfo
• LookerApi30Reference.DialectInfoOptions
• LookerApi30Reference.Error
• LookerApi30Reference.GitBranch
• LookerApi30Reference.GitConnectionTest
• LookerApi30Reference.GitConnectionTestResult
• LookerApi30Reference.GitStatus
• LookerApi30Reference.Group
• LookerApi30Reference.GroupIdForGroupInclusion
• LookerApi30Reference.GroupIdForGroupUserInclusion
• LookerApi30Reference.HomepageItem
• LookerApi30Reference.HomepageSection
• LookerApi30Reference.ImportedProject
• LookerApi30Reference.Integration
• LookerApi30Reference.IntegrationHub
• LookerApi30Reference.IntegrationParam
• LookerApi30Reference.IntegrationRequiredField
• LookerApi30Reference.IntegrationTestResult
• LookerApi30Reference.LDAPConfig
• LookerApi30Reference.LDAPConfigTestIssue
• LookerApi30Reference.LDAPConfigTestResult
• LookerApi30Reference.LDAPGroupRead
• LookerApi30Reference.LDAPGroupWrite
• LookerApi30Reference.LDAPUser
• LookerApi30Reference.LDAPUserAttributeRead
• LookerApi30Reference.LDAPUserAttributeWrite
• LookerApi30Reference.LegacyFeature
• LookerApi30Reference.LocalizationSettings
• LookerApi30Reference.Look
• LookerApi30Reference.LookBasic
• LookerApi30Reference.LookModel
• LookerApi30Reference.LookWithDashboards
• LookerApi30Reference.LookWithQuery
• LookerApi30Reference.LookmlModel
• LookerApi30Reference.LookmlModelExplore
• LookerApi30Reference.LookmlModelExploreAccessFilter
• LookerApi30Reference.LookmlModelExploreAlias
• LookerApi30Reference.LookmlModelExploreAlwaysFilter
• LookerApi30Reference.LookmlModelExploreConditionallyFilter
• LookerApi30Reference.LookmlModelExploreError
• LookerApi30Reference.LookmlModelExploreField
• LookerApi30Reference.LookmlModelExploreFieldEnumeration
• LookerApi30Reference.LookmlModelExploreFieldMapLayer
• LookerApi30Reference.LookmlModelExploreFieldSqlCase
• LookerApi30Reference.LookmlModelExploreFieldTimeInterval
• LookerApi30Reference.LookmlModelExploreFieldset
• LookerApi30Reference.LookmlModelExploreJoins
• LookerApi30Reference.LookmlModelExploreSet
• LookerApi30Reference.LookmlModelExploreSupportedMeasureType
• LookerApi30Reference.LookmlModelNavExplore
• LookerApi30Reference.Manifest
• LookerApi30Reference.ModelSet
• LookerApi30Reference.ModelsNotValidated
• LookerApi30Reference.OIDCConfig
• LookerApi30Reference.OIDCGroupRead
• LookerApi30Reference.OIDCGroupWrite
• LookerApi30Reference.OIDCUserAttributeRead
• LookerApi30Reference.OIDCUserAttributeWrite
• LookerApi30Reference.Permission
• LookerApi30Reference.PermissionSet
• LookerApi30Reference.Prefetch
• LookerApi30Reference.PrefetchAccessFilterValue
• LookerApi30Reference.PrefetchDashboardFilterValue
• LookerApi30Reference.PrefetchDashboardRequest
• LookerApi30Reference.Project
• LookerApi30Reference.ProjectError
• LookerApi30Reference.ProjectFile
• LookerApi30Reference.ProjectValidation
• LookerApi30Reference.ProjectValidationCache
• LookerApi30Reference.ProjectWorkspace
• LookerApi30Reference.Query
• LookerApi30Reference.QueryTask
• LookerApi30Reference.RenderTask
• LookerApi30Reference.ResultMakerFilterables
• LookerApi30Reference.ResultMakerFilterablesListen
• LookerApi30Reference.ResultMakerWithIdVisConfigAndDynamicFields
• LookerApi30Reference.Role
• LookerApi30Reference.RunningQueries
• LookerApi30Reference.SamlConfig
• LookerApi30Reference.SamlGroupRead
• LookerApi30Reference.SamlGroupWrite
• LookerApi30Reference.SamlMetadataParseResult
• LookerApi30Reference.SamlUserAttributeRead
• LookerApi30Reference.SamlUserAttributeWrite
• LookerApi30Reference.ScheduledPlan
• LookerApi30Reference.ScheduledPlanDestination
• LookerApi30Reference.Session
• LookerApi30Reference.Snippet
• LookerApi30Reference.Space
• LookerApi30Reference.SpaceBase
• LookerApi30Reference.SqlQuery
• LookerApi30Reference.SqlQueryCreate
• LookerApi30Reference.Timezone
• LookerApi30Reference.User
• LookerApi30Reference.UserAttribute
• LookerApi30Reference.UserAttributeGroupValue
• LookerApi30Reference.UserAttributeWithValue
• LookerApi30Reference.UserIdOnly
• LookerApi30Reference.UserPublic
• LookerApi30Reference.ValidationError
• LookerApi30Reference.ValidationErrorDetail
• LookerApi30Reference.WhitelabelConfiguration
• LookerApi30Reference.Workspace

Documentation for Authorization

All endpoints do not require authorization.