Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 2.88 KB

SessionApi.md

File metadata and controls

119 lines (76 loc) · 2.88 KB
Raw

LookerApi30Reference.SessionApi

All URIs are relative to https://madisonreed.looker.com:19999/api/3.0

Method HTTP request Description
session GET /session Get Session
updateSession PATCH /session Update Session

session

ApiSession session

Get Session

Get API Session

Returns information about the current API session, such as which workspace is selected for the session.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.SessionApi()

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

Parameters

This endpoint does not need any parameter.

Return type

ApiSession

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateSession

ApiSession updateSession(body)

Update Session

Update API Session

API Session Workspace

You can use this endpoint to change the active workspace for the current API session.

Only one workspace can be active in a session. The active workspace can be changed any number of times in a session.

The default workspace for API sessions is the "production" workspace.

All Looker APIs that use projects or lookml models (such as running queries) will use the version of project and model files defined by this workspace for the lifetime of the current API session or until the session workspace is changed again.

An API session has the same lifetime as the access_token used to authenticate API requests. Each successful API login generates a new access_token and a new API session.

If your Looker API client application needs to work in a dev workspace across multiple API sessions, be sure to select the dev workspace after each login.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.SessionApi()

var body = new LookerApi30Reference.ApiSession(); // {ApiSession} Session


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

Parameters

Name Type Description Notes
body ApiSession Session

Return type

ApiSession

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json