lookerapi.ProjectApi

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

Method	HTTP request	Description
all_git_branches	GET /projects/{project_id}/git_branches	Get All Git Branchs
all_git_connection_tests	GET /projects/{project_id}/git_connection_tests	Get All Git Connection Tests
all_project_files	GET /projects/{project_id}/files	Get All Project Files
all_projects	GET /projects	Get All Projects
create_git_deploy_key	POST /projects/{project_id}/git/deploy_key	Create Deploy Key
create_project	POST /projects	Create Project
git_deploy_key	GET /projects/{project_id}/git/deploy_key	Git Deploy Key
project	GET /projects/{project_id}	Get Project
project_file	GET /projects/{project_id}/files/file	Get Project File
project_validation_results	GET /projects/{project_id}/validate	Cached Project Validation Results
project_workspace	GET /projects/{project_id}/current_workspace	Get Project Workspace
reset_project_to_production	POST /projects/{project_id}/reset_to_production	Reset To Production
reset_project_to_remote	POST /projects/{project_id}/reset_to_remote	Reset To Remote
run_git_connection_test	GET /projects/{project_id}/git_connection_tests/{test_id}	Run Git Connection Test
update_project	PATCH /projects/{project_id}	Update Project
validate_project	POST /projects/{project_id}/validate	Validate Project

all_git_branches

list[GitBranch] all_git_branches(project_id)

Get All Git Branchs

Get All Git Branches Returns a list of git branches in the project repository

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id

try: 
    # Get All Git Branchs
    api_response = api_instance.all_git_branches(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->all_git_branches: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id

Return type

list[GitBranch]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

all_git_connection_tests

list[GitConnectionTest] all_git_connection_tests(project_id)

Get All Git Connection Tests

Get All Git Connection Tests Returns a list of tests which can be run against a project's git connection

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id

try: 
    # Get All Git Connection Tests
    api_response = api_instance.all_git_connection_tests(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->all_git_connection_tests: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id

Return type

list[GitConnectionTest]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

all_project_files

list[ProjectFile] all_project_files(project_id, fields=fields)

Get All Project Files

Get All Project Files Returns a list of the files in the project

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Get All Project Files
    api_response = api_instance.all_project_files(project_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->all_project_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
fields	str	Requested fields	[optional]

Return type

list[ProjectFile]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

all_projects

list[Project] all_projects(fields=fields)

Get All Projects

Get All Projects Returns all projects visible to the current user

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Get All Projects
    api_response = api_instance.all_projects(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->all_projects: %s\n" % e)

Parameters

Name	Type	Description	Notes
fields	str	Requested fields	[optional]

Return type

list[Project]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_git_deploy_key

str create_git_deploy_key(project_id)

Create Deploy Key

Create Git Deploy Key Create a public/private key pair for authenticating ssh git requests from Looker to a remote git repository for a particular Looker project. Returns the public key of the generated ssh key pair. Copy this public key to your remote git repository's ssh keys configuration so that the remote git service can validate and accept git requests from the Looker server.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id

try: 
    # Create Deploy Key
    api_response = api_instance.create_git_deploy_key(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_git_deploy_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_project

Project create_project(body=body)

Create Project

Create A Project dev mode required. - Call `update_session` to select the 'dev' workspace. `name` is required. `git_remote_url` is not allowed. To configure Git for the newly created project, follow the instructions in `update_project`.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
body = lookerapi.Project() # Project | Project (optional)

try: 
    # Create Project
    api_response = api_instance.create_project(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Project	Project	[optional]

Return type

Project

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

git_deploy_key

str git_deploy_key(project_id)

Git Deploy Key

Git Deploy Key Returns the ssh public key previously created for a project's git repository.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id

try: 
    # Git Deploy Key
    api_response = api_instance.git_deploy_key(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->git_deploy_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

project

Project project(project_id, fields=fields)

Get Project

Get A Project Returns the project with the given project id

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Get Project
    api_response = api_instance.project(project_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
fields	str	Requested fields	[optional]

Return type

Project

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

project_file

ProjectFile project_file(project_id, file_id, fields=fields)

Get Project File

Get Project File Info Returns information about a file in the project

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
file_id = 'file_id_example' # str | File Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Get Project File
    api_response = api_instance.project_file(project_id, file_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->project_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
file_id	str	File Id
fields	str	Requested fields	[optional]

Return type

ProjectFile

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

project_validation_results

ProjectValidationCache project_validation_results(project_id, fields=fields)

Cached Project Validation Results

Get Cached Project Validation Results Returns the cached results of a previous project validation calculation, if any. Returns http status 204 No Content if no validation results exist. Validating the content of all the files in a project can be computationally intensive for large projects. Use this API to simply fetch the results of the most recent project validation rather than revalidating the entire project from scratch. A value of `\"stale\": true` in the response indicates that the project has changed since the cached validation results were computed. The cached validation results may no longer reflect the current state of the project.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Cached Project Validation Results
    api_response = api_instance.project_validation_results(project_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->project_validation_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
fields	str	Requested fields	[optional]

Return type

ProjectValidationCache

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

project_workspace

ProjectWorkspace project_workspace(project_id, fields=fields)

Get Project Workspace

Get Project Workspace Returns information about the state of the project files in the currently selected workspace

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Get Project Workspace
    api_response = api_instance.project_workspace(project_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->project_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
fields	str	Requested fields	[optional]

Return type

ProjectWorkspace

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_project_to_production

str reset_project_to_production(project_id)

Reset To Production

Reset a project to the revision of the project that is in production. DANGER this will delete any changes that have not been pushed to a remote repository.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Id of project

try: 
    # Reset To Production
    api_response = api_instance.reset_project_to_production(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->reset_project_to_production: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Id of project

Return type

str

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_project_to_remote

str reset_project_to_remote(project_id)

Reset To Remote

Reset a project development branch to the revision of the project that is on the remote. DANGER this will delete any changes that have not been pushed to a remote repository.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Id of project

try: 
    # Reset To Remote
    api_response = api_instance.reset_project_to_remote(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->reset_project_to_remote: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Id of project

Return type

str

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

run_git_connection_test

GitConnectionTestResult run_git_connection_test(project_id, test_id)

Run Git Connection Test

Run a git connection test Run the named test on the git service used by this project and return the result. This is intended to help debug git connections when things do not work properly, to give more helpful information about why a git url is not working with Looker. They are intended to be run in the order they are returned from the /projects/ID/git_connection_tests endpoint.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
test_id = 'test_id_example' # str | Test Id

try: 
    # Run Git Connection Test
    api_response = api_instance.run_git_connection_test(project_id, test_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->run_git_connection_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
test_id	str	Test Id

Return type

GitConnectionTestResult

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_project

Project update_project(project_id, body, fields=fields)

Update Project

Update Project Configuration Apply changes to a project's configuration. #### Configuring Git for a Project To set up a Looker project with a remote git repository, follow these steps: 1. Call `update_session` to select the 'dev' workspace. 1. Call `create_git_deploy_key` to create a new deploy key for the project 1. Copy the deploy key text into the remote git repository's ssh key configuration 1. Call `update_project` to set project's `git_remote_url` ()and `git_service_name`, if necessary). When you modify a project's `git_remote_url`, Looker connects to the remote repository to fetch metadata. The remote git repository MUST be configured with the Looker-generated deploy key for this project prior to setting the project's `git_remote_url`. To set up a Looker project with a git repository residing on the Looker server (a 'bare' git repo): 1. Call `update_session` to select the 'dev' workspace. 1. Call `update_project` setting `git_remote_url` to nil and `git_service_name` to "bare".

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
body = lookerapi.Project() # Project | Project
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Update Project
    api_response = api_instance.update_project(project_id, body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->update_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
body	Project	Project
fields	str	Requested fields	[optional]

Return type

Project

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_project

ProjectValidation validate_project(project_id, fields=fields)

Validate Project

Validate Project Performs lint validation of all lookml files in the project. Returns a list of errors found, if any. Validating the content of all the files in a project can be computationally intensive for large projects. For best performance, call `validate_project(project_id)` only when you really want to recompute project validation. To quickly display the results of the most recent project validation (without recomputing), use `project_validation_results(project_id)`

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.ProjectApi()
project_id = 'project_id_example' # str | Project Id
fields = 'fields_example' # str | Requested fields (optional)

try: 
    # Validate Project
    api_response = api_instance.validate_project(project_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->validate_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project Id
fields	str	Requested fields	[optional]

Return type

ProjectValidation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ProjectApi.md

Latest commit

History

ProjectApi.md

File metadata and controls

lookerapi.ProjectApi

all_git_branches

Get All Git Branches Returns a list of git branches in the project repository

Example

Parameters

Return type

Authorization

HTTP request headers

all_git_connection_tests

Get All Git Connection Tests Returns a list of tests which can be run against a project's git connection

Example

Parameters

Return type

Authorization

HTTP request headers

all_project_files

Get All Project Files Returns a list of the files in the project

Example

Parameters

Return type

Authorization

HTTP request headers

all_projects

Get All Projects Returns all projects visible to the current user

Example

Parameters

Return type

Authorization

HTTP request headers

create_git_deploy_key

Example

Parameters

Return type

Authorization

HTTP request headers

create_project

Create A Project dev mode required. - Call update_session to select the 'dev' workspace. name is required. git_remote_url is not allowed. To configure Git for the newly created project, follow the instructions in update_project.

Example

Parameters

Return type

Authorization

HTTP request headers

git_deploy_key

Git Deploy Key Returns the ssh public key previously created for a project's git repository.

Example

Parameters

Return type

Authorization

HTTP request headers

project

Get A Project Returns the project with the given project id

Example

Parameters

Return type

Authorization

HTTP request headers

project_file

Get Project File Info Returns information about a file in the project

Example

Parameters

Return type

Authorization

HTTP request headers

project_validation_results

Example

Parameters

Return type

Authorization

HTTP request headers

project_workspace

Get Project Workspace Returns information about the state of the project files in the currently selected workspace

Example

Parameters

Return type

Create A Project dev mode required. - Call `update_session` to select the 'dev' workspace. `name` is required. `git_remote_url` is not allowed. To configure Git for the newly created project, follow the instructions in `update_project`.