Giters

anonrose / looker-node-api

a node implementation of the v3.1 looker api

Home Page:https://www.npmjs.com/package/looker-node-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

Class Method HTTP request Description
LookerApi31Reference.ApiAuthApi login POST /login Login
LookerApi31Reference.ApiAuthApi loginUser POST /login/{user_id} Login user
LookerApi31Reference.ApiAuthApi logout DELETE /logout Logout
LookerApi31Reference.AuthApi createOidcTestConfig POST /oidc_test_configs Create OIDC Test Configuration
LookerApi31Reference.AuthApi createSamlTestConfig POST /saml_test_configs Create SAML Test Configuration
LookerApi31Reference.AuthApi deleteOidcTestConfig DELETE /oidc_test_configs/{test_slug} Delete OIDC Test Configuration
LookerApi31Reference.AuthApi deleteSamlTestConfig DELETE /saml_test_configs/{test_slug} Delete SAML Test Configuration
LookerApi31Reference.AuthApi fetchAndParseSamlIdpMetadata POST /fetch_and_parse_saml_idp_metadata Parse SAML IdP Url
LookerApi31Reference.AuthApi forcePasswordResetAtNextLoginForAllUsers PUT /password_config/force_password_reset_at_next_login_for_all_users Force password reset
LookerApi31Reference.AuthApi ldapConfig GET /ldap_config Get LDAP Configuration
LookerApi31Reference.AuthApi oidcConfig GET /oidc_config Get OIDC Configuration
LookerApi31Reference.AuthApi oidcTestConfig GET /oidc_test_configs/{test_slug} Get OIDC Test Configuration
LookerApi31Reference.AuthApi parseSamlIdpMetadata POST /parse_saml_idp_metadata Parse SAML IdP XML
LookerApi31Reference.AuthApi passwordConfig GET /password_config Get Password Config
LookerApi31Reference.AuthApi samlConfig GET /saml_config Get SAML Configuration
LookerApi31Reference.AuthApi samlTestConfig GET /saml_test_configs/{test_slug} Get SAML Test Configuration
LookerApi31Reference.AuthApi sessionConfig GET /session_config Get Session Config
LookerApi31Reference.AuthApi testLdapConfigAuth PUT /ldap_config/test_auth Test LDAP Auth
LookerApi31Reference.AuthApi testLdapConfigConnection PUT /ldap_config/test_connection Test LDAP Connection
LookerApi31Reference.AuthApi testLdapConfigUserAuth PUT /ldap_config/test_user_auth Test LDAP User Auth
LookerApi31Reference.AuthApi testLdapConfigUserInfo PUT /ldap_config/test_user_info Test LDAP User Info
LookerApi31Reference.AuthApi updateLdapConfig PATCH /ldap_config Update LDAP Configuration
LookerApi31Reference.AuthApi updateOidcConfig PATCH /oidc_config Update OIDC Configuration
LookerApi31Reference.AuthApi updatePasswordConfig PATCH /password_config Update Password Config
LookerApi31Reference.AuthApi updateSamlConfig PATCH /saml_config Update SAML Configuration
LookerApi31Reference.AuthApi updateSessionConfig PATCH /session_config Update Session Config
LookerApi31Reference.ColorCollectionApi allColorCollections GET /color_collections Get all Color Collections
LookerApi31Reference.ColorCollectionApi colorCollection GET /color_collections/{collection_id} Get Color Collection by ID
LookerApi31Reference.ColorCollectionApi colorCollectionsCustom GET /color_collections/custom Get all Custom Color Collections
LookerApi31Reference.ColorCollectionApi colorCollectionsStandard GET /color_collections/standard Get all Standard Color Collections
LookerApi31Reference.ColorCollectionApi createColorCollection POST /color_collections Create ColorCollection
LookerApi31Reference.ColorCollectionApi defaultColorCollection GET /color_collections/default Get Default Color Collection
LookerApi31Reference.ColorCollectionApi deleteColorCollection DELETE /color_collections/{collection_id} Delete ColorCollection
LookerApi31Reference.ColorCollectionApi setDefaultColorCollection PUT /color_collections/default Set Default Color Collection
LookerApi31Reference.ColorCollectionApi updateColorCollection PATCH /color_collections/{collection_id} Update Custom Color collection
LookerApi31Reference.ConfigApi allLegacyFeatures GET /legacy_features Get All Legacy Features
LookerApi31Reference.ConfigApi allLocales GET /locales Get All Locales
LookerApi31Reference.ConfigApi allTimezones GET /timezones Get All Timezones
LookerApi31Reference.ConfigApi backupConfiguration GET /backup_configuration Get Backup Configuration
LookerApi31Reference.ConfigApi legacyFeature GET /legacy_features/{legacy_feature_id} Get Legacy Feature
LookerApi31Reference.ConfigApi updateBackupConfiguration PATCH /backup_configuration Update Backup Configuration
LookerApi31Reference.ConfigApi updateLegacyFeature PATCH /legacy_features/{legacy_feature_id} Update Legacy Feature
LookerApi31Reference.ConfigApi updateWhitelabelConfiguration PUT /whitelabel_configuration Update Whitelabel configuration
LookerApi31Reference.ConfigApi versions GET /versions Get ApiVersion
LookerApi31Reference.ConfigApi whitelabelConfiguration GET /whitelabel_configuration Get Whitelabel configuration
LookerApi31Reference.ConnectionApi allConnections GET /connections Get All Connections
LookerApi31Reference.ConnectionApi allDialectInfos GET /dialect_info Get All Dialect Infos
LookerApi31Reference.ConnectionApi connection GET /connections/{connection_name} Get Connection
LookerApi31Reference.ConnectionApi createConnection POST /connections Create Connection
LookerApi31Reference.ConnectionApi deleteConnection DELETE /connections/{connection_name} Delete Connection
LookerApi31Reference.ConnectionApi deleteConnectionOverride DELETE /connections/{connection_name}/connection_override/{override_context} Delete Connection Override
LookerApi31Reference.ConnectionApi testConnection PUT /connections/{connection_name}/test Test Connection
LookerApi31Reference.ConnectionApi testConnectionConfig PUT /connections/test Test Connection Configuration
LookerApi31Reference.ConnectionApi updateConnection PATCH /connections/{connection_name} Update Connection
LookerApi31Reference.ContentApi allContentMetadataAccesses GET /content_metadata_access Get All Content Metadata Accesses
LookerApi31Reference.ContentApi allContentMetadatas GET /content_metadata Get All Content Metadatas
LookerApi31Reference.ContentApi contentFavorite GET /content_favorite/{content_favorite_id} Get Favorite Content
LookerApi31Reference.ContentApi contentMetadata GET /content_metadata/{content_metadata_id} Get Content Metadata
LookerApi31Reference.ContentApi contentValidation GET /content_validation Validate Content
LookerApi31Reference.ContentApi createContentFavorite POST /content_favorite Create Favorite Content
LookerApi31Reference.ContentApi createContentMetadataAccess POST /content_metadata_access Create Content Metadata Access
LookerApi31Reference.ContentApi deleteContentFavorite DELETE /content_favorite/{content_favorite_id} Delete Favorite Content
LookerApi31Reference.ContentApi deleteContentMetadataAccess DELETE /content_metadata_access/{content_metadata_access_id} Delete Content Metadata Access
LookerApi31Reference.ContentApi searchContentFavorites GET /content_favorite/search Search Favorite Contents
LookerApi31Reference.ContentApi searchContentViews GET /content_view/search Search Content Views
LookerApi31Reference.ContentApi updateContentMetadata PATCH /content_metadata/{content_metadata_id} Update Content Metadata
LookerApi31Reference.ContentApi updateContentMetadataAccess PUT /content_metadata_access/{content_metadata_access_id} Update Content Metadata Access
LookerApi31Reference.DashboardApi allDashboards GET /dashboards Get All Dashboards
LookerApi31Reference.DashboardApi createDashboard POST /dashboards Create Dashboard
LookerApi31Reference.DashboardApi createDashboardElement POST /dashboard_elements Create DashboardElement
LookerApi31Reference.DashboardApi createDashboardFilter POST /dashboard_filters Create Dashboard Filter
LookerApi31Reference.DashboardApi createDashboardLayout POST /dashboard_layouts Create DashboardLayout
LookerApi31Reference.DashboardApi dashboard GET /dashboards/{dashboard_id} Get Dashboard
LookerApi31Reference.DashboardApi dashboardDashboardElements GET /dashboards/{dashboard_id}/dashboard_elements Get All DashboardElements
LookerApi31Reference.DashboardApi dashboardDashboardFilters GET /dashboards/{dashboard_id}/dashboard_filters Get All Dashboard Filters
LookerApi31Reference.DashboardApi dashboardDashboardLayouts GET /dashboards/{dashboard_id}/dashboard_layouts Get All DashboardLayouts
LookerApi31Reference.DashboardApi dashboardElement GET /dashboard_elements/{dashboard_element_id} Get DashboardElement
LookerApi31Reference.DashboardApi dashboardFilter GET /dashboard_filters/{dashboard_filter_id} Get Dashboard Filter
LookerApi31Reference.DashboardApi dashboardLayout GET /dashboard_layouts/{dashboard_layout_id} Get DashboardLayout
LookerApi31Reference.DashboardApi dashboardLayoutComponent GET /dashboard_layout_components/{dashboard_layout_component_id} Get DashboardLayoutComponent
LookerApi31Reference.DashboardApi dashboardLayoutDashboardLayoutComponents GET /dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components Get All DashboardLayoutComponents
LookerApi31Reference.DashboardApi deleteDashboard DELETE /dashboards/{dashboard_id} Delete Dashboard
LookerApi31Reference.DashboardApi deleteDashboardElement DELETE /dashboard_elements/{dashboard_element_id} Delete DashboardElement
LookerApi31Reference.DashboardApi deleteDashboardFilter DELETE /dashboard_filters/{dashboard_filter_id} Delete Dashboard Filter
LookerApi31Reference.DashboardApi deleteDashboardLayout DELETE /dashboard_layouts/{dashboard_layout_id} Delete DashboardLayout
LookerApi31Reference.DashboardApi importLookmlDashboard POST /dashboards/{lookml_dashboard_id}/import/{space_id} Import LookML Dashboard
LookerApi31Reference.DashboardApi searchDashboardElements GET /dashboard_elements/search Search Dashboard Elements
LookerApi31Reference.DashboardApi searchDashboards GET /dashboards/search Search Dashboards
LookerApi31Reference.DashboardApi syncLookmlDashboard PATCH /dashboards/{lookml_dashboard_id}/sync Sync LookML Dashboard
LookerApi31Reference.DashboardApi updateDashboard PATCH /dashboards/{dashboard_id} Update Dashboard
LookerApi31Reference.DashboardApi updateDashboardElement PATCH /dashboard_elements/{dashboard_element_id} Update DashboardElement
LookerApi31Reference.DashboardApi updateDashboardFilter PATCH /dashboard_filters/{dashboard_filter_id} Update Dashboard Filter
LookerApi31Reference.DashboardApi updateDashboardLayout PATCH /dashboard_layouts/{dashboard_layout_id} Update DashboardLayout
LookerApi31Reference.DashboardApi updateDashboardLayoutComponent PATCH /dashboard_layout_components/{dashboard_layout_component_id} Update DashboardLayoutComponent
LookerApi31Reference.DataActionApi fetchRemoteDataActionForm POST /data_actions/form Fetch Remote Data Action Form
LookerApi31Reference.DataActionApi performDataAction POST /data_actions Send a Data Action
LookerApi31Reference.DatagroupApi allDatagroups GET /datagroups Get All Datagroups
LookerApi31Reference.DatagroupApi datagroup GET /datagroups/{datagroup_id} Get Datagroup
LookerApi31Reference.DatagroupApi updateDatagroup PATCH /datagroups/{datagroup_id} Update Datagroup
LookerApi31Reference.FolderApi allFolders GET /folders Get All Folders
LookerApi31Reference.FolderApi createFolder POST /folders Create Folder
LookerApi31Reference.FolderApi deleteFolder DELETE /folders/{folder_id} Delete Folder
LookerApi31Reference.FolderApi folder GET /folders/{folder_id} Get Folder
LookerApi31Reference.FolderApi folderAncestors GET /folders/{folder_id}/ancestors Get Folder Ancestors
LookerApi31Reference.FolderApi folderChildren GET /folders/{folder_id}/children Get Folder Children
LookerApi31Reference.FolderApi folderChildrenSearch GET /folders/{folder_id}/children/search Search Folder Children
LookerApi31Reference.FolderApi folderDashboards GET /folders/{folder_id}/dashboards Get Folder Dashboards
LookerApi31Reference.FolderApi folderLooks GET /folders/{folder_id}/looks Get Folder Looks
LookerApi31Reference.FolderApi folderParent GET /folders/{folder_id}/parent Get Folder Parent
LookerApi31Reference.FolderApi searchFolders GET /folders/search Search Folders
LookerApi31Reference.FolderApi updateFolder PATCH /folders/{folder_id} Update Folder
LookerApi31Reference.GroupApi addGroupGroup POST /groups/{group_id}/groups Add a Group to Group
LookerApi31Reference.GroupApi addGroupUser POST /groups/{group_id}/users Add a User to Group
LookerApi31Reference.GroupApi allGroupGroups GET /groups/{group_id}/groups Get All Groups in Group
LookerApi31Reference.GroupApi allGroupUsers GET /groups/{group_id}/users Get All Users in Group
LookerApi31Reference.GroupApi allGroups GET /groups Get All Groups
LookerApi31Reference.GroupApi createGroup POST /groups Create Group
LookerApi31Reference.GroupApi deleteGroup DELETE /groups/{group_id} Delete Group
LookerApi31Reference.GroupApi deleteGroupFromGroup DELETE /groups/{group_id}/groups/{deleting_group_id} Deletes a Group from Group
LookerApi31Reference.GroupApi deleteGroupUser DELETE /groups/{group_id}/users/{user_id} Remove a User from Group
LookerApi31Reference.GroupApi deleteUserAttributeGroupValue DELETE /groups/{group_id}/attribute_values/{user_attribute_id} Delete User Attribute Group Value
LookerApi31Reference.GroupApi group GET /groups/{group_id} Get Group
LookerApi31Reference.GroupApi updateGroup PATCH /groups/{group_id} Update Group
LookerApi31Reference.GroupApi updateUserAttributeGroupValue PATCH /groups/{group_id}/attribute_values/{user_attribute_id} Set User Attribute Group Value
LookerApi31Reference.HomepageApi allHomepageItems GET /homepage_items Get All Homepage Items
LookerApi31Reference.HomepageApi allHomepageSections GET /homepage_sections Get All Homepage sections
LookerApi31Reference.HomepageApi allHomepages GET /homepages Get All Homepages
LookerApi31Reference.HomepageApi createHomepage POST /homepages Create Homepage
LookerApi31Reference.HomepageApi createHomepageItem POST /homepage_items Create Homepage Item
LookerApi31Reference.HomepageApi createHomepageSection POST /homepage_sections Create Homepage section
LookerApi31Reference.HomepageApi deleteHomepage DELETE /homepages/{homepage_id} Delete Homepage
LookerApi31Reference.HomepageApi deleteHomepageItem DELETE /homepage_items/{homepage_item_id} Delete Homepage Item
LookerApi31Reference.HomepageApi deleteHomepageSection DELETE /homepage_sections/{homepage_section_id} Delete Homepage section
LookerApi31Reference.HomepageApi homepage GET /homepages/{homepage_id} Get Homepage
LookerApi31Reference.HomepageApi homepageItem GET /homepage_items/{homepage_item_id} Get Homepage Item
LookerApi31Reference.HomepageApi homepageSection GET /homepage_sections/{homepage_section_id} Get Homepage section
LookerApi31Reference.HomepageApi searchHomepages GET /homepages/search Search Homepages
LookerApi31Reference.HomepageApi updateHomepage PATCH /homepages/{homepage_id} Update Homepage
LookerApi31Reference.HomepageApi updateHomepageItem PATCH /homepage_items/{homepage_item_id} Update Homepage Item
LookerApi31Reference.HomepageApi updateHomepageSection PATCH /homepage_sections/{homepage_section_id} Update Homepage section
LookerApi31Reference.IntegrationApi acceptIntegrationHubLegalAgreement POST /integration_hubs/{integration_hub_id}/accept_legal_agreement Accept Integration Hub Legal Agreement
LookerApi31Reference.IntegrationApi allIntegrationHubs GET /integration_hubs Get All Integration Hubs
LookerApi31Reference.IntegrationApi allIntegrations GET /integrations Get All Integrations
LookerApi31Reference.IntegrationApi createIntegrationHub POST /integration_hubs Create Integration Hub
LookerApi31Reference.IntegrationApi deleteIntegrationHub DELETE /integration_hubs/{integration_hub_id} Delete Integration Hub
LookerApi31Reference.IntegrationApi fetchIntegrationForm POST /integrations/{integration_id}/form Fetch Remote Integration Form
LookerApi31Reference.IntegrationApi integration GET /integrations/{integration_id} Get Integration
LookerApi31Reference.IntegrationApi integrationHub GET /integration_hubs/{integration_hub_id} Get Integration Hub
LookerApi31Reference.IntegrationApi testIntegration POST /integrations/{integration_id}/test Test integration
LookerApi31Reference.IntegrationApi updateIntegration PATCH /integrations/{integration_id} Update Integration
LookerApi31Reference.IntegrationApi updateIntegrationHub PATCH /integration_hubs/{integration_hub_id} Update Integration Hub
LookerApi31Reference.LookApi allLooks GET /looks Get All Looks
LookerApi31Reference.LookApi createLook POST /looks Create Look
LookerApi31Reference.LookApi deleteLook DELETE /looks/{look_id} Delete Look
LookerApi31Reference.LookApi look GET /looks/{look_id} Get Look
LookerApi31Reference.LookApi runLook GET /looks/{look_id}/run/{result_format} Run Look
LookerApi31Reference.LookApi searchLooks GET /looks/search Search Looks
LookerApi31Reference.LookApi updateLook PATCH /looks/{look_id} Update Look
LookerApi31Reference.LookmlModelApi allLookmlModels GET /lookml_models Get All LookML Models
LookerApi31Reference.LookmlModelApi createLookmlModel POST /lookml_models Create LookML Model
LookerApi31Reference.LookmlModelApi deleteLookmlModel DELETE /lookml_models/{lookml_model_name} Delete LookML Model
LookerApi31Reference.LookmlModelApi lookmlModel GET /lookml_models/{lookml_model_name} Get LookML Model
LookerApi31Reference.LookmlModelApi lookmlModelExplore GET /lookml_models/{lookml_model_name}/explores/{explore_name} Get LookML Model Explore
LookerApi31Reference.LookmlModelApi updateLookmlModel PATCH /lookml_models/{lookml_model_name} Update LookML Model
LookerApi31Reference.ProjectApi allGitBranches GET /projects/{project_id}/git_branches Get All Git Branches
LookerApi31Reference.ProjectApi allGitConnectionTests GET /projects/{project_id}/git_connection_tests Get All Git Connection Tests
LookerApi31Reference.ProjectApi allProjectFiles GET /projects/{project_id}/files Get All Project Files
LookerApi31Reference.ProjectApi allProjects GET /projects Get All Projects
LookerApi31Reference.ProjectApi createGitBranch POST /projects/{project_id}/git_branch Checkout New Git Branch
LookerApi31Reference.ProjectApi createGitDeployKey POST /projects/{project_id}/git/deploy_key Create Deploy Key
LookerApi31Reference.ProjectApi createProject POST /projects Create Project
LookerApi31Reference.ProjectApi deleteGitBranch DELETE /projects/{project_id}/git_branch/{branch_name} Delete a Git Branch
LookerApi31Reference.ProjectApi deleteRepositoryCredential DELETE /projects/{root_project_id}/credential/{credential_id} Delete Repository Credential
LookerApi31Reference.ProjectApi deployToProduction POST /projects/{project_id}/deploy_to_production Deploy To Production
LookerApi31Reference.ProjectApi findGitBranch GET /projects/{project_id}/git_branch/{branch_name} Find a Git Branch
LookerApi31Reference.ProjectApi getAllRepositoryCredentials GET /projects/{root_project_id}/credentials Get All Repository Credentials
LookerApi31Reference.ProjectApi gitBranch GET /projects/{project_id}/git_branch Get Active Git Branch
LookerApi31Reference.ProjectApi gitDeployKey GET /projects/{project_id}/git/deploy_key Git Deploy Key
LookerApi31Reference.ProjectApi manifest GET /projects/{project_id}/manifest Get Manifest
LookerApi31Reference.ProjectApi project GET /projects/{project_id} Get Project
LookerApi31Reference.ProjectApi projectFile GET /projects/{project_id}/files/file Get Project File
LookerApi31Reference.ProjectApi projectValidationResults GET /projects/{project_id}/validate Cached Project Validation Results
LookerApi31Reference.ProjectApi projectWorkspace GET /projects/{project_id}/current_workspace Get Project Workspace
LookerApi31Reference.ProjectApi resetProjectToProduction POST /projects/{project_id}/reset_to_production Reset To Production
LookerApi31Reference.ProjectApi resetProjectToRemote POST /projects/{project_id}/reset_to_remote Reset To Remote
LookerApi31Reference.ProjectApi runGitConnectionTest GET /projects/{project_id}/git_connection_tests/{test_id} Run Git Connection Test
LookerApi31Reference.ProjectApi updateGitBranch PUT /projects/{project_id}/git_branch Update Project Git Branch
LookerApi31Reference.ProjectApi updateProject PATCH /projects/{project_id} Update Project
LookerApi31Reference.ProjectApi updateRepositoryCredential PUT /projects/{root_project_id}/credential/{credential_id} Create Repository Credential
LookerApi31Reference.ProjectApi validateProject POST /projects/{project_id}/validate Validate Project
LookerApi31Reference.QueryApi allRunningQueries GET /running_queries Get All Running Queries
LookerApi31Reference.QueryApi createMergeQuery POST /merge_queries Create Merge Query
LookerApi31Reference.QueryApi createQuery POST /queries Create Query
LookerApi31Reference.QueryApi createQueryTask POST /query_tasks Run Query Async
LookerApi31Reference.QueryApi createSqlQuery POST /sql_queries Create SQL Runner Query
LookerApi31Reference.QueryApi killQuery DELETE /running_queries/{query_task_id} Kill Running Query
LookerApi31Reference.QueryApi mergeQuery GET /merge_queries/{merge_query_id} Get Merge Query
LookerApi31Reference.QueryApi query GET /queries/{query_id} Get Query
LookerApi31Reference.QueryApi queryForSlug GET /queries/slug/{slug} Get Query for Slug
LookerApi31Reference.QueryApi queryTask GET /query_tasks/{query_task_id} Get Async Query Info
LookerApi31Reference.QueryApi queryTaskMultiResults GET /query_tasks/multi_results Get Multiple Async Query Results
LookerApi31Reference.QueryApi queryTaskResults GET /query_tasks/{query_task_id}/results Get Async Query Results
LookerApi31Reference.QueryApi runInlineQuery POST /queries/run/{result_format} Run Inline Query
LookerApi31Reference.QueryApi runQuery GET /queries/{query_id}/run/{result_format} Run Query
LookerApi31Reference.QueryApi runSqlQuery POST /sql_queries/{slug}/run/{result_format} Run SQL Runner Query
LookerApi31Reference.QueryApi runUrlEncodedQuery GET /queries/models/{model_name}/views/{view_name}/run/{result_format} Run Url Encoded Query
LookerApi31Reference.QueryApi sqlQuery GET /sql_queries/{slug} Get SQL Runner Query
LookerApi31Reference.RenderTaskApi createDashboardRenderTask POST /render_tasks/dashboards/{dashboard_id}/{result_format} Create Dashboard Render Task
LookerApi31Reference.RenderTaskApi createLookRenderTask POST /render_tasks/looks/{look_id}/{result_format} Create Look Render Task
LookerApi31Reference.RenderTaskApi createLookmlDashboardRenderTask POST /render_tasks/lookml_dashboards/{dashboard_id}/{result_format} Create Lookml Dashboard Render Task
LookerApi31Reference.RenderTaskApi createQueryRenderTask POST /render_tasks/queries/{query_id}/{result_format} Create Query Render Task
LookerApi31Reference.RenderTaskApi renderTask GET /render_tasks/{render_task_id} Get Render Task
LookerApi31Reference.RenderTaskApi renderTaskResults GET /render_tasks/{render_task_id}/results Render Task Results
LookerApi31Reference.RoleApi allModelSets GET /model_sets Get All Model Sets
LookerApi31Reference.RoleApi allPermissionSets GET /permission_sets Get All Permission Sets
LookerApi31Reference.RoleApi allPermissions GET /permissions Get All Permissions
LookerApi31Reference.RoleApi allRoles GET /roles Get All Roles
LookerApi31Reference.RoleApi createModelSet POST /model_sets Create Model Set
LookerApi31Reference.RoleApi createPermissionSet POST /permission_sets Create Permission Set
LookerApi31Reference.RoleApi createRole POST /roles Create Role
LookerApi31Reference.RoleApi deleteModelSet DELETE /model_sets/{model_set_id} Delete Model Set
LookerApi31Reference.RoleApi deletePermissionSet DELETE /permission_sets/{permission_set_id} Delete Permission Set
LookerApi31Reference.RoleApi deleteRole DELETE /roles/{role_id} Delete Role
LookerApi31Reference.RoleApi modelSet GET /model_sets/{model_set_id} Get Model Set
LookerApi31Reference.RoleApi permissionSet GET /permission_sets/{permission_set_id} Get Permission Set
LookerApi31Reference.RoleApi role GET /roles/{role_id} Get Role
LookerApi31Reference.RoleApi roleGroups GET /roles/{role_id}/groups Get Role Groups
LookerApi31Reference.RoleApi roleUsers GET /roles/{role_id}/users Get Role Users
LookerApi31Reference.RoleApi setRoleGroups PUT /roles/{role_id}/groups Update Role Groups
LookerApi31Reference.RoleApi setRoleUsers PUT /roles/{role_id}/users Update Role Users
LookerApi31Reference.RoleApi updateModelSet PATCH /model_sets/{model_set_id} Update Model Set
LookerApi31Reference.RoleApi updatePermissionSet PATCH /permission_sets/{permission_set_id} Update Permission Set
LookerApi31Reference.RoleApi updateRole PATCH /roles/{role_id} Update Role
LookerApi31Reference.ScheduledPlanApi allScheduledPlans GET /scheduled_plans Get All Scheduled Plans
LookerApi31Reference.ScheduledPlanApi createScheduledPlan POST /scheduled_plans Create Scheduled Plan
LookerApi31Reference.ScheduledPlanApi deleteScheduledPlan DELETE /scheduled_plans/{scheduled_plan_id} Delete Scheduled Plan
LookerApi31Reference.ScheduledPlanApi scheduledPlan GET /scheduled_plans/{scheduled_plan_id} Get Scheduled Plan
LookerApi31Reference.ScheduledPlanApi scheduledPlanRunOnce POST /scheduled_plans/run_once Run Scheduled Plan Once
LookerApi31Reference.ScheduledPlanApi scheduledPlansForDashboard GET /scheduled_plans/dashboard/{dashboard_id} Scheduled Plans for Dashboard
LookerApi31Reference.ScheduledPlanApi scheduledPlansForLook GET /scheduled_plans/look/{look_id} Scheduled Plans for Look
LookerApi31Reference.ScheduledPlanApi scheduledPlansForLookmlDashboard GET /scheduled_plans/lookml_dashboard/{lookml_dashboard_id} Scheduled Plans for LookML Dashboard
LookerApi31Reference.ScheduledPlanApi scheduledPlansForSpace GET /scheduled_plans/space/{space_id} Scheduled Plans for Space
LookerApi31Reference.ScheduledPlanApi updateScheduledPlan PATCH /scheduled_plans/{scheduled_plan_id} Update Scheduled Plan
LookerApi31Reference.SessionApi session GET /session Get Session
LookerApi31Reference.SessionApi updateSession PATCH /session Update Session
LookerApi31Reference.SpaceApi allSpaces GET /spaces Get All Spaces
LookerApi31Reference.SpaceApi createSpace POST /spaces Create Space
LookerApi31Reference.SpaceApi deleteSpace DELETE /spaces/{space_id} Delete Space
LookerApi31Reference.SpaceApi searchSpaces GET /spaces/search Search Spaces
LookerApi31Reference.SpaceApi space GET /spaces/{space_id} Get Space
LookerApi31Reference.SpaceApi spaceAncestors GET /spaces/{space_id}/ancestors Get Space Ancestors
LookerApi31Reference.SpaceApi spaceChildren GET /spaces/{space_id}/children Get Space Children
LookerApi31Reference.SpaceApi spaceChildrenSearch GET /spaces/{space_id}/children/search Search Space Children
LookerApi31Reference.SpaceApi spaceDashboards GET /spaces/{space_id}/dashboards Get Space Dashboards
LookerApi31Reference.SpaceApi spaceLooks GET /spaces/{space_id}/looks Get Space Looks
LookerApi31Reference.SpaceApi spaceParent GET /spaces/{space_id}/parent Get Space Parent
LookerApi31Reference.SpaceApi updateSpace PATCH /spaces/{space_id} Update Space
LookerApi31Reference.ThemeApi activeThemes GET /themes/active Get Active Themes
LookerApi31Reference.ThemeApi allThemes GET /themes Get All Themes
LookerApi31Reference.ThemeApi createTheme POST /themes Create Theme
LookerApi31Reference.ThemeApi defaultTheme GET /themes/default Get Default Theme
LookerApi31Reference.ThemeApi deleteTheme DELETE /themes/{theme_id} Delete Theme
LookerApi31Reference.ThemeApi searchThemes GET /themes/search Search Themes
LookerApi31Reference.ThemeApi setDefaultTheme PUT /themes/default Set Default Theme
LookerApi31Reference.ThemeApi theme GET /themes/{theme_id} Get Theme
LookerApi31Reference.ThemeApi themeOrDefault GET /themes/theme_or_default Get Theme or Default
LookerApi31Reference.ThemeApi updateTheme PATCH /themes/{theme_id} Update Theme
LookerApi31Reference.ThemeApi validateTheme POST /themes/validate Validate Theme
LookerApi31Reference.UserApi allUserCredentialsApi3s GET /users/{user_id}/credentials_api3 Get All API 3 Credentials
LookerApi31Reference.UserApi allUserCredentialsEmbeds GET /users/{user_id}/credentials_embed Get All Embedding Credentials
LookerApi31Reference.UserApi allUserSessions GET /users/{user_id}/sessions Get All Web Login Sessions
LookerApi31Reference.UserApi allUsers GET /users Get All Users
LookerApi31Reference.UserApi createUser POST /users Create User
LookerApi31Reference.UserApi createUserCredentialsApi3 POST /users/{user_id}/credentials_api3 Create API 3 Credential
LookerApi31Reference.UserApi createUserCredentialsEmail POST /users/{user_id}/credentials_email Create Email/Password Credential
LookerApi31Reference.UserApi createUserCredentialsEmailPasswordReset POST /users/{user_id}/credentials_email/password_reset Create Password Reset Token
LookerApi31Reference.UserApi createUserCredentialsTotp POST /users/{user_id}/credentials_totp Create Two-Factor Credential
LookerApi31Reference.UserApi deleteUser DELETE /users/{user_id} Delete User
LookerApi31Reference.UserApi deleteUserAttributeUserValue DELETE /users/{user_id}/attribute_values/{user_attribute_id} Delete User Attribute User Value
LookerApi31Reference.UserApi deleteUserCredentialsApi3 DELETE /users/{user_id}/credentials_api3/{credentials_api3_id} Delete API 3 Credential
LookerApi31Reference.UserApi deleteUserCredentialsEmail DELETE /users/{user_id}/credentials_email Delete Email/Password Credential
LookerApi31Reference.UserApi deleteUserCredentialsEmbed DELETE /users/{user_id}/credentials_embed/{credentials_embed_id} Delete Embedding Credential
LookerApi31Reference.UserApi deleteUserCredentialsGoogle DELETE /users/{user_id}/credentials_google Delete Google Auth Credential
LookerApi31Reference.UserApi deleteUserCredentialsLdap DELETE /users/{user_id}/credentials_ldap Delete LDAP Credential
LookerApi31Reference.UserApi deleteUserCredentialsLookerOpenid DELETE /users/{user_id}/credentials_looker_openid Delete Looker OpenId Credential
LookerApi31Reference.UserApi deleteUserCredentialsOidc DELETE /users/{user_id}/credentials_oidc Delete OIDC Auth Credential
LookerApi31Reference.UserApi deleteUserCredentialsSaml DELETE /users/{user_id}/credentials_saml Delete Saml Auth Credential
LookerApi31Reference.UserApi deleteUserCredentialsTotp DELETE /users/{user_id}/credentials_totp Delete Two-Factor Credential
LookerApi31Reference.UserApi deleteUserSession DELETE /users/{user_id}/sessions/{session_id} Delete Web Login Session
LookerApi31Reference.UserApi me GET /user Get Current User
LookerApi31Reference.UserApi searchUsers GET /users/search Search Users
LookerApi31Reference.UserApi searchUsersNames GET /users/search/names/{pattern} Search User Names
LookerApi31Reference.UserApi setUserAttributeUserValue PATCH /users/{user_id}/attribute_values/{user_attribute_id} Set User Attribute User Value
LookerApi31Reference.UserApi setUserRoles PUT /users/{user_id}/roles Set User Roles
LookerApi31Reference.UserApi updateUser PATCH /users/{user_id} Update User
LookerApi31Reference.UserApi updateUserCredentialsEmail PATCH /users/{user_id}/credentials_email Update Email/Password Credential
LookerApi31Reference.UserApi user GET /users/{user_id} Get User by Id
LookerApi31Reference.UserApi userAttributeUserValues GET /users/{user_id}/attribute_values Get User Attribute Values
LookerApi31Reference.UserApi userCredentialsApi3 GET /users/{user_id}/credentials_api3/{credentials_api3_id} Get API 3 Credential
LookerApi31Reference.UserApi userCredentialsEmail GET /users/{user_id}/credentials_email Get Email/Password Credential
LookerApi31Reference.UserApi userCredentialsEmbed GET /users/{user_id}/credentials_embed/{credentials_embed_id} Get Embedding Credential
LookerApi31Reference.UserApi userCredentialsGoogle GET /users/{user_id}/credentials_google Get Google Auth Credential
LookerApi31Reference.UserApi userCredentialsLdap GET /users/{user_id}/credentials_ldap Get LDAP Credential
LookerApi31Reference.UserApi userCredentialsLookerOpenid GET /users/{user_id}/credentials_looker_openid Get Looker OpenId Credential
LookerApi31Reference.UserApi userCredentialsOidc GET /users/{user_id}/credentials_oidc Get OIDC Auth Credential
LookerApi31Reference.UserApi userCredentialsSaml GET /users/{user_id}/credentials_saml Get Saml Auth Credential
LookerApi31Reference.UserApi userCredentialsTotp GET /users/{user_id}/credentials_totp Get Two-Factor Credential
LookerApi31Reference.UserApi userForCredential GET /users/credential/{credential_type}/{credential_id} Get User by Credential Id
LookerApi31Reference.UserApi userRoles GET /users/{user_id}/roles Get User Roles
LookerApi31Reference.UserApi userSession GET /users/{user_id}/sessions/{session_id} Get Web Login Session
LookerApi31Reference.UserAttributeApi allUserAttributeGroupValues GET /user_attributes/{user_attribute_id}/group_values Get User Attribute Group Values
LookerApi31Reference.UserAttributeApi allUserAttributes GET /user_attributes Get All User Attributes
LookerApi31Reference.UserAttributeApi createUserAttribute POST /user_attributes Create User Attribute
LookerApi31Reference.UserAttributeApi deleteUserAttribute DELETE /user_attributes/{user_attribute_id} Delete User Attribute
LookerApi31Reference.UserAttributeApi setUserAttributeGroupValues POST /user_attributes/{user_attribute_id}/group_values Set User Attribute Group Values
LookerApi31Reference.UserAttributeApi updateUserAttribute PATCH /user_attributes/{user_attribute_id} Update User Attribute
LookerApi31Reference.UserAttributeApi userAttribute GET /user_attributes/{user_attribute_id} Get User Attribute
LookerApi31Reference.WorkspaceApi allWorkspaces GET /workspaces Get All Workspaces
LookerApi31Reference.WorkspaceApi workspace GET /workspaces/{workspace_id} Get Workspace

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

a node implementation of the v3.1 looker api

https://www.npmjs.com/package/looker-node-api

Languages

Language:JavaScript 100.0%