@looker/api-explorer 0.9.22 → 0.9.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +50 -0
- package/lib/ApiExplorer.d.ts +4 -39
- package/lib/ApiExplorer.js +23 -24
- package/lib/ApiExplorer.js.map +1 -1
- package/lib/App.d.ts +1 -0
- package/lib/App.js +29 -0
- package/lib/App.js.map +1 -0
- package/lib/StandaloneApiExplorer.js +8 -13
- package/lib/StandaloneApiExplorer.js.map +1 -1
- package/lib/components/DocMarkdown/DocMarkdown.js +5 -5
- package/lib/components/DocMarkdown/DocMarkdown.js.map +1 -1
- package/lib/components/DocSdkUsage/DocSdkUsage.js +3 -6
- package/lib/components/DocSdkUsage/DocSdkUsage.js.map +1 -1
- package/lib/components/DocSource/DocSource.js +5 -7
- package/lib/components/DocSource/DocSource.js.map +1 -1
- package/lib/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.d.ts +1 -1
- package/lib/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.js +152 -8
- package/lib/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.js.map +1 -1
- package/lib/components/SelectorContainer/SdkLanguageSelector.js +1 -1
- package/lib/components/SelectorContainer/SdkLanguageSelector.js.map +1 -1
- package/lib/components/SideNav/SideNav.js +1 -1
- package/lib/components/SideNav/SideNav.js.map +1 -1
- package/lib/components/common/Loader.d.ts +1 -1
- package/lib/components/common/Loader.js.map +1 -1
- package/lib/esm/ApiExplorer.js +25 -26
- package/lib/esm/ApiExplorer.js.map +1 -1
- package/lib/esm/App.js +19 -0
- package/lib/esm/App.js.map +1 -0
- package/lib/esm/StandaloneApiExplorer.js +7 -10
- package/lib/esm/StandaloneApiExplorer.js.map +1 -1
- package/lib/esm/components/DocMarkdown/DocMarkdown.js +3 -3
- package/lib/esm/components/DocMarkdown/DocMarkdown.js.map +1 -1
- package/lib/esm/components/DocSdkUsage/DocSdkUsage.js +5 -7
- package/lib/esm/components/DocSdkUsage/DocSdkUsage.js.map +1 -1
- package/lib/esm/components/DocSource/DocSource.js +4 -5
- package/lib/esm/components/DocSource/DocSource.js.map +1 -1
- package/lib/esm/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.js +153 -6
- package/lib/esm/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.js.map +1 -1
- package/lib/esm/components/SelectorContainer/SdkLanguageSelector.js +2 -2
- package/lib/esm/components/SelectorContainer/SdkLanguageSelector.js.map +1 -1
- package/lib/esm/components/SideNav/SideNav.js +2 -2
- package/lib/esm/components/SideNav/SideNav.js.map +1 -1
- package/lib/esm/components/common/Loader.js.map +1 -1
- package/lib/esm/index.js +4 -18
- package/lib/esm/index.js.map +1 -1
- package/lib/esm/routes/AppRouter.js +2 -2
- package/lib/esm/routes/AppRouter.js.map +1 -1
- package/lib/esm/scenes/MethodScene/MethodScene.js +9 -11
- package/lib/esm/scenes/MethodScene/MethodScene.js.map +1 -1
- package/lib/esm/state/index.js +1 -0
- package/lib/esm/state/index.js.map +1 -1
- package/lib/esm/state/lodes/index.js +3 -0
- package/lib/{test-utils/envAdaptor.js.map → esm/state/lodes/index.js.map} +1 -1
- package/lib/esm/state/lodes/sagas.js +25 -0
- package/lib/esm/state/lodes/sagas.js.map +1 -0
- package/lib/esm/state/lodes/selectors.js +5 -0
- package/lib/esm/state/lodes/selectors.js.map +1 -0
- package/lib/esm/state/lodes/slice.js +30 -0
- package/lib/esm/state/lodes/slice.js.map +1 -0
- package/lib/esm/state/settings/sagas.js +28 -16
- package/lib/esm/state/settings/sagas.js.map +1 -1
- package/lib/esm/state/settings/selectors.js +5 -5
- package/lib/esm/state/settings/selectors.js.map +1 -1
- package/lib/esm/state/settings/slice.js +8 -8
- package/lib/esm/state/settings/slice.js.map +1 -1
- package/lib/esm/state/store.js +6 -3
- package/lib/esm/state/store.js.map +1 -1
- package/lib/esm/test-utils/index.js +1 -2
- package/lib/esm/test-utils/index.js.map +1 -1
- package/lib/esm/test-utils/lodes.js +12 -0
- package/lib/esm/test-utils/lodes.js.map +1 -0
- package/lib/esm/test-utils/redux.js +11 -8
- package/lib/esm/test-utils/redux.js.map +1 -1
- package/lib/esm/utils/index.js +0 -1
- package/lib/esm/utils/index.js.map +1 -1
- package/lib/esm/utils/lodeUtils.js +3 -7
- package/lib/esm/utils/lodeUtils.js.map +1 -1
- package/lib/index.d.ts +4 -1
- package/lib/index.js +52 -23
- package/lib/index.js.map +1 -1
- package/lib/routes/AppRouter.d.ts +2 -2
- package/lib/routes/AppRouter.js +2 -2
- package/lib/routes/AppRouter.js.map +1 -1
- package/lib/scenes/MethodScene/MethodScene.d.ts +2 -2
- package/lib/scenes/MethodScene/MethodScene.js +7 -9
- package/lib/scenes/MethodScene/MethodScene.js.map +1 -1
- package/lib/state/index.d.ts +1 -0
- package/lib/state/index.js +13 -0
- package/lib/state/index.js.map +1 -1
- package/lib/state/lodes/index.d.ts +2 -0
- package/lib/state/lodes/index.js +32 -0
- package/lib/state/lodes/index.js.map +1 -0
- package/lib/state/lodes/sagas.d.ts +1 -0
- package/lib/state/lodes/sagas.js +34 -0
- package/lib/state/lodes/sagas.js.map +1 -0
- package/lib/state/lodes/selectors.d.ts +3 -0
- package/lib/state/lodes/selectors.js +17 -0
- package/lib/state/lodes/selectors.js.map +1 -0
- package/lib/state/lodes/slice.d.ts +29 -0
- package/lib/state/lodes/slice.js +45 -0
- package/lib/state/lodes/slice.js.map +1 -0
- package/lib/state/settings/sagas.js +28 -15
- package/lib/state/settings/sagas.js.map +1 -1
- package/lib/state/settings/selectors.js +5 -5
- package/lib/state/settings/selectors.js.map +1 -1
- package/lib/state/settings/slice.d.ts +13 -13
- package/lib/state/settings/slice.js +13 -13
- package/lib/state/settings/slice.js.map +1 -1
- package/lib/state/store.d.ts +3 -0
- package/lib/state/store.js +6 -2
- package/lib/state/store.js.map +1 -1
- package/lib/test-data/declarations.js +24 -0
- package/lib/test-data/declarations.js.map +1 -0
- package/lib/test-data/index.js +23 -0
- package/lib/test-data/index.js.map +1 -1
- package/lib/test-utils/index.d.ts +1 -2
- package/lib/test-utils/index.js +12 -28
- package/lib/test-utils/index.js.map +1 -1
- package/lib/test-utils/lodes.d.ts +4 -0
- package/lib/test-utils/lodes.js +23 -0
- package/lib/test-utils/lodes.js.map +1 -0
- package/lib/test-utils/redux.d.ts +3 -1
- package/lib/test-utils/redux.js +12 -8
- package/lib/test-utils/redux.js.map +1 -1
- package/lib/utils/index.d.ts +0 -1
- package/lib/utils/index.js +0 -24
- package/lib/utils/index.js.map +1 -1
- package/lib/utils/lodeUtils.d.ts +2 -2
- package/lib/utils/lodeUtils.js +3 -7
- package/lib/utils/lodeUtils.js.map +1 -1
- package/package.json +11 -10
- package/public/Looker.3.1.json +1343 -412
- package/public/Looker.4.0.json +3305 -661
- package/src/ApiExplorer.tsx +99 -102
- package/src/{index.tsx → App.tsx} +0 -0
- package/src/StandaloneApiExplorer.tsx +8 -16
- package/src/components/DocMarkdown/DocMarkdown.tsx +3 -3
- package/src/components/DocSdkUsage/DocSdkUsage.spec.tsx +2 -2
- package/src/components/DocSdkUsage/DocSdkUsage.tsx +5 -5
- package/src/components/DocSource/DocSource.tsx +4 -3
- package/src/components/ErrorBoundary/components/SomethingWentWrong/SomethingWentWrong.spec.tsx +1 -1
- package/src/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/SomethingWentWrongGraphic.tsx +170 -6
- package/src/components/SelectorContainer/SdkLanguageSelector.spec.tsx +3 -5
- package/src/components/SelectorContainer/SdkLanguageSelector.tsx +2 -2
- package/src/components/SideNav/SideNav.tsx +2 -2
- package/src/components/common/Loader.tsx +1 -1
- package/src/{context/lode/index.ts → index.ts} +4 -1
- package/src/routes/AppRouter.tsx +5 -4
- package/src/scenes/MethodScene/MethodScene.tsx +11 -11
- package/src/state/index.ts +1 -0
- package/src/{context → state/lodes}/index.ts +2 -1
- package/src/state/lodes/sagas.spec.ts +92 -0
- package/src/state/lodes/sagas.ts +51 -0
- package/src/state/lodes/selectors.spec.ts +42 -0
- package/src/{test-utils/envAdaptor.ts → state/lodes/selectors.ts} +8 -5
- package/src/{test-utils/render_with_lode.tsx → state/lodes/slice.ts} +37 -37
- package/src/state/settings/sagas.spec.ts +25 -21
- package/src/state/settings/sagas.ts +16 -16
- package/src/state/settings/selectors.spec.ts +1 -5
- package/src/state/settings/selectors.ts +5 -5
- package/src/state/settings/slice.ts +12 -7
- package/src/state/store.ts +7 -2
- package/src/{context/lode/LodeContext.ts → test-data/declarations.ts} +17 -14
- package/src/test-data/index.ts +1 -0
- package/src/test-utils/index.ts +1 -5
- package/src/test-utils/lodes.tsx +41 -0
- package/src/test-utils/redux.tsx +19 -7
- package/src/utils/index.ts +0 -1
- package/src/utils/lodeUtils.ts +4 -6
- package/webpack.dev.config.js +3 -0
- package/webpack.prod.config.js +4 -0
- package/lib/context/index.d.ts +0 -1
- package/lib/context/index.js +0 -20
- package/lib/context/index.js.map +0 -1
- package/lib/context/lode/LodeContext.d.ts +0 -9
- package/lib/context/lode/LodeContext.js +0 -21
- package/lib/context/lode/LodeContext.js.map +0 -1
- package/lib/context/lode/index.d.ts +0 -1
- package/lib/context/lode/index.js +0 -20
- package/lib/context/lode/index.js.map +0 -1
- package/lib/esm/context/index.js +0 -2
- package/lib/esm/context/index.js.map +0 -1
- package/lib/esm/context/lode/LodeContext.js +0 -11
- package/lib/esm/context/lode/LodeContext.js.map +0 -1
- package/lib/esm/context/lode/index.js +0 -2
- package/lib/esm/context/lode/index.js.map +0 -1
- package/lib/esm/test-utils/envAdaptor.js +0 -5
- package/lib/esm/test-utils/envAdaptor.js.map +0 -1
- package/lib/esm/test-utils/render_with_lode.js +0 -19
- package/lib/esm/test-utils/render_with_lode.js.map +0 -1
- package/lib/esm/utils/envAdaptor.js +0 -84
- package/lib/esm/utils/envAdaptor.js.map +0 -1
- package/lib/test-utils/envAdaptor.d.ts +0 -2
- package/lib/test-utils/envAdaptor.js +0 -15
- package/lib/test-utils/render_with_lode.d.ts +0 -7
- package/lib/test-utils/render_with_lode.js +0 -36
- package/lib/test-utils/render_with_lode.js.map +0 -1
- package/lib/utils/envAdaptor.d.ts +0 -31
- package/lib/utils/envAdaptor.js +0 -106
- package/lib/utils/envAdaptor.js.map +0 -1
- package/src/components/ErrorBoundary/components/SomethingWentWrong/components/SomethingWentWrongGraphic/somethingWentWrong.svg +0 -45
- package/src/utils/envAdaptor.spec.ts +0 -50
- package/src/utils/envAdaptor.ts +0 -147
package/public/Looker.3.1.json
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
"swagger": "2.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"version": "3.1.0",
|
|
5
|
-
"x-looker-release-version": "21.
|
|
5
|
+
"x-looker-release-version": "21.20.2",
|
|
6
6
|
"title": "Looker API 3.1 Reference",
|
|
7
|
-
"description": "### Authorization\n\nThe
|
|
7
|
+
"description": "### Authorization\n\nThe classic method of API authorization uses Looker **API3** credentials for authorization and access control.\nLooker admins can create API3 credentials on Looker's **Admin/Users** page.\n\nAPI 4.0 adds additional ways to authenticate API requests, including OAuth and CORS requests.\n\nFor details, see [Looker API Authorization](https://looker.com/docs/r/api/authorization).\n\n\n### API Explorer\n\nThe API Explorer is a Looker-provided utility with many new and unique features for learning and using the Looker API and SDKs.\nIt is a replacement for the 'api-docs' page currently provided on Looker instances.\n\nFor details, see the [API Explorer documentation](https://looker.com/docs/r/api/explorer).\n\n\n### Looker Language SDKs\n\nThe Looker API is a RESTful system that should be usable by any programming language capable of making\nHTTPS requests. SDKs for a variety of programming languages are also provided to streamline using the API. Looker\nhas an OpenSource [sdk-codegen project](https://github.com/looker-open-source/sdk-codegen) that provides several\nlanguage SDKs. Language SDKs generated by `sdk-codegen` have an Authentication manager that can automatically\nauthenticate API requests when needed.\n\nFor details on available Looker SDKs, see [Looker API Client SDKs](https://looker.com/docs/r/api/client_sdks).\n\n\n### API Versioning\n\nFuture releases of Looker expand the latest API version release-by-release to securely expose more and more of the core\npower of the Looker platform to API client applications. API endpoints marked as \"beta\" may receive breaking changes without\nwarning (but we will try to avoid doing that). Stable (non-beta) API endpoints should not receive breaking\nchanges in future releases.\n\nFor details, see [Looker API Versioning](https://looker.com/docs/r/api/versioning).\n\n\n### Try It Out!\n\nThis section describes the existing 'api-docs' page available on Looker instances. We recommend using the\n[API Explorer](https://looker.com/docs/r/api/explorer) instead.\n\nThe 'api-docs' page served by the Looker instance includes 'Try It Out!' buttons for each API method. After logging\nin with API3 credentials, you can use the \"Try It Out!\" buttons to call the API directly from the documentation\npage to interactively explore API features and responses.\n\n**NOTE**! With great power comes great responsibility: The \"Try It Out!\" button makes API calls to your live Looker\ninstance. Be especially careful with destructive API operations such as `delete_user` or similar.\nThere is no \"undo\" for API operations. (API Explorer's \"Run It\" feature requires a check mark before running\nAPI operations that can change data.)\n\n\n### In This Release\n\nThe following are a few examples of noteworthy items that have changed between API 3.0 and API 3.1.\nFor more comprehensive coverage of API changes, please see the release notes for your Looker release.\n\n### Examples of new things added in API 3.1 (compared to API 3.0):\n\n* [Dashboard construction](#!/3.1/Dashboard/) APIs\n* [Themes](#!/3.1/Theme/) and [custom color collections](#!/3.1/ColorCollection) APIs\n* Create and run [SQL Runner](#!/3.1/Query/run_sql_query) queries\n* Create and run [merged results](#!/3.1/Query/create_merge_query) queries\n* Create and modify [dashboard filters](#!/3.1/Dashboard/create_dashboard_filter)\n* Create and modify [password requirements](#!/3.1/Auth/password_config)\n\n### Deprecated in API 3.0\n\nThe following functions and properties have been deprecated in API 3.0. They continue to exist and work in API 3.0\nfor the next several Looker releases but they have not been carried forward to API 3.1:\n\n* Dashboard Prefetch functions\n* User access_filter functions\n* User API 1.0 credentials functions\n* Space.is_root and Space.is_user_root properties. Use Space.is_shared_root and Space.is_users_root instead.\n\n### Semantic changes in API 3.1:\n\n* [all_looks()](#!/3.1/Look/all_looks) no longer includes soft-deleted looks, matching [all_dashboards()](#!/3.1/Dashboard/all_dashboards) behavior.\nYou can find soft-deleted looks using [search_looks()](#!/3.1/Look/search_looks) with the `deleted` param set to True.\n* [all_spaces()](#!/3.1/Space/all_spaces) no longer includes duplicate items\n* [search_users()](#!/3.1/User/search_users) no longer accepts Y,y,1,0,N,n for Boolean params, only \"true\" and \"false\".\n* For greater client and network compatibility, [render_task_results](#!/3.1/RenderTask/render_task_results) now returns\nHTTP status **202 Accepted** instead of HTTP status **102 Processing**\n* [all_running_queries()](#!/3.1/Query/all_running_queries) and [kill_query](#!/3.1/Query/kill_query) functions have moved into the [Query](#!/3.1/Query/) function group.\n\nThe API Explorer can be used to [interactively compare](https://looker.com/docs/r/api/explorer#comparing_api_versions) the differences between API 3.1 and 4.0.\n\n\n### API and SDK Support Policies\n\nLooker API versions and language SDKs have varying support levels. Please read the API and SDK\n[support policies](https://looker.com/docs/r/api/support-policy) for more information.\n\n\n",
|
|
8
8
|
"contact": {
|
|
9
9
|
"name": "Looker Team",
|
|
10
10
|
"url": "https://help.looker.com"
|
|
@@ -15,10 +15,16 @@
|
|
|
15
15
|
}
|
|
16
16
|
},
|
|
17
17
|
"basePath": "/api/3.1",
|
|
18
|
-
"consumes": [
|
|
19
|
-
|
|
18
|
+
"consumes": [
|
|
19
|
+
"application/json"
|
|
20
|
+
],
|
|
21
|
+
"produces": [
|
|
22
|
+
"application/json"
|
|
23
|
+
],
|
|
20
24
|
"host": "localhost:20000",
|
|
21
|
-
"schemes": [
|
|
25
|
+
"schemes": [
|
|
26
|
+
"https"
|
|
27
|
+
],
|
|
22
28
|
"tags": [
|
|
23
29
|
{
|
|
24
30
|
"name": "ApiAuth",
|
|
@@ -56,6 +62,10 @@
|
|
|
56
62
|
"name": "Datagroup",
|
|
57
63
|
"description": "Manage Datagroups"
|
|
58
64
|
},
|
|
65
|
+
{
|
|
66
|
+
"name": "DerivedTable",
|
|
67
|
+
"description": "View Derived Table graphs"
|
|
68
|
+
},
|
|
59
69
|
{
|
|
60
70
|
"name": "Folder",
|
|
61
71
|
"description": "Manage Folders"
|
|
@@ -128,7 +138,9 @@
|
|
|
128
138
|
"paths": {
|
|
129
139
|
"/query_tasks": {
|
|
130
140
|
"post": {
|
|
131
|
-
"tags": [
|
|
141
|
+
"tags": [
|
|
142
|
+
"Query"
|
|
143
|
+
],
|
|
132
144
|
"operationId": "create_query_task",
|
|
133
145
|
"summary": "Run Query Async",
|
|
134
146
|
"description": "### Create an async query task\n\nCreates a query task (job) to run a previously created query asynchronously. Returns a Query Task ID.\n\nUse [query_task(query_task_id)](#!/Query/query_task) to check the execution status of the query task.\nAfter the query task status reaches \"Complete\", use [query_task_results(query_task_id)](#!/Query/query_task_results) to fetch the results of the query.\n",
|
|
@@ -281,7 +293,9 @@
|
|
|
281
293
|
},
|
|
282
294
|
"/query_tasks/multi_results": {
|
|
283
295
|
"get": {
|
|
284
|
-
"tags": [
|
|
296
|
+
"tags": [
|
|
297
|
+
"Query"
|
|
298
|
+
],
|
|
285
299
|
"operationId": "query_task_multi_results",
|
|
286
300
|
"summary": "Get Multiple Async Query Results",
|
|
287
301
|
"description": "### Fetch results of multiple async queries\n\nReturns the results of multiple async queries in one request.\n\nFor Query Tasks that are not completed, the response will include the execution status of the Query Task but will not include query results.\nQuery Tasks whose results have expired will have a status of 'expired'.\nIf the user making the API request does not have sufficient privileges to view a Query Task result, the result will have a status of 'missing'\n",
|
|
@@ -327,7 +341,9 @@
|
|
|
327
341
|
},
|
|
328
342
|
"/query_tasks/{query_task_id}": {
|
|
329
343
|
"get": {
|
|
330
|
-
"tags": [
|
|
344
|
+
"tags": [
|
|
345
|
+
"Query"
|
|
346
|
+
],
|
|
331
347
|
"operationId": "query_task",
|
|
332
348
|
"summary": "Get Async Query Info",
|
|
333
349
|
"description": "### Get Query Task details\n\nUse this function to check the status of an async query task. After the status\nreaches \"Complete\", you can call [query_task_results(query_task_id)](#!/Query/query_task_results) to\nretrieve the results of the query.\n\nUse [create_query_task()](#!/Query/create_query_task) to create an async query task.\n",
|
|
@@ -373,11 +389,16 @@
|
|
|
373
389
|
},
|
|
374
390
|
"/query_tasks/{query_task_id}/results": {
|
|
375
391
|
"get": {
|
|
376
|
-
"tags": [
|
|
392
|
+
"tags": [
|
|
393
|
+
"Query"
|
|
394
|
+
],
|
|
377
395
|
"operationId": "query_task_results",
|
|
378
396
|
"summary": "Get Async Query Results",
|
|
379
397
|
"description": "### Get Async Query Results\n\nReturns the results of an async query task if the query has completed.\n\nIf the query task is still running or waiting to run, this function returns 204 No Content.\n\nIf the query task ID is invalid or the cached results of the query task have expired, this function returns 404 Not Found.\n\nUse [query_task(query_task_id)](#!/Query/query_task) to check the execution status of the query task\nCall query_task_results only after the query task status reaches \"Complete\".\n\nYou can also use [query_task_multi_results()](#!/Query/query_task_multi_results) retrieve the\nresults of multiple async query tasks at the same time.\n\n#### SQL Error Handling:\nIf the query fails due to a SQL db error, how this is communicated depends on the result_format you requested in `create_query_task()`.\n\nFor `json_detail` result_format: `query_task_results()` will respond with HTTP status '200 OK' and db SQL error info\nwill be in the `errors` property of the response object. The 'data' property will be empty.\n\nFor all other result formats: `query_task_results()` will respond with HTTP status `400 Bad Request` and some db SQL error info\nwill be in the message of the 400 error response, but not as detailed as expressed in `json_detail.errors`.\nThese data formats can only carry row data, and error info is not row data.\n",
|
|
380
|
-
"produces": [
|
|
398
|
+
"produces": [
|
|
399
|
+
"text",
|
|
400
|
+
"application/json"
|
|
401
|
+
],
|
|
381
402
|
"parameters": [
|
|
382
403
|
{
|
|
383
404
|
"name": "query_task_id",
|
|
@@ -419,7 +440,9 @@
|
|
|
419
440
|
},
|
|
420
441
|
"/queries/{query_id}": {
|
|
421
442
|
"get": {
|
|
422
|
-
"tags": [
|
|
443
|
+
"tags": [
|
|
444
|
+
"Query"
|
|
445
|
+
],
|
|
423
446
|
"operationId": "query",
|
|
424
447
|
"summary": "Get Query",
|
|
425
448
|
"description": "### Get a previously created query by id.\n\nA Looker query object includes the various parameters that define a database query that has been run or\ncould be run in the future. These parameters include: model, view, fields, filters, pivots, etc.\nQuery *results* are not part of the query object.\n\nQuery objects are unique and immutable. Query objects are created automatically in Looker as users explore data.\nLooker does not delete them; they become part of the query history. When asked to create a query for\nany given set of parameters, Looker will first try to find an existing query object with matching\nparameters and will only create a new object when an appropriate object can not be found.\n\nThis 'get' method is used to get the details about a query for a given id. See the other methods here\nto 'create' and 'run' queries.\n\nNote that some fields like 'filter_config' and 'vis_config' etc are specific to how the Looker UI\nbuilds queries and visualizations and are not generally useful for API use. They are not required when\ncreating new queries and can usually just be ignored.\n\n",
|
|
@@ -466,7 +489,9 @@
|
|
|
466
489
|
},
|
|
467
490
|
"/queries/slug/{slug}": {
|
|
468
491
|
"get": {
|
|
469
|
-
"tags": [
|
|
492
|
+
"tags": [
|
|
493
|
+
"Query"
|
|
494
|
+
],
|
|
470
495
|
"operationId": "query_for_slug",
|
|
471
496
|
"summary": "Get Query for Slug",
|
|
472
497
|
"description": "### Get the query for a given query slug.\n\nThis returns the query for the 'slug' in a query share URL.\n\nThe 'slug' is a randomly chosen short string that is used as an alternative to the query's id value\nfor use in URLs etc. This method exists as a convenience to help you use the API to 'find' queries that\nhave been created using the Looker UI.\n\nYou can use the Looker explore page to build a query and then choose the 'Share' option to\nshow the share url for the query. Share urls generally look something like 'https://looker.yourcompany/x/vwGSbfc'.\nThe trailing 'vwGSbfc' is the share slug. You can pass that string to this api method to get details about the query.\nThose details include the 'id' that you can use to run the query. Or, you can copy the query body\n(perhaps with your own modification) and use that as the basis to make/run new queries.\n\nThis will also work with slugs from Looker explore urls like\n'https://looker.yourcompany/explore/ecommerce/orders?qid=aogBgL6o3cKK1jN3RoZl5s'. In this case\n'aogBgL6o3cKK1jN3RoZl5s' is the slug.\n",
|
|
@@ -512,7 +537,9 @@
|
|
|
512
537
|
},
|
|
513
538
|
"/queries": {
|
|
514
539
|
"post": {
|
|
515
|
-
"tags": [
|
|
540
|
+
"tags": [
|
|
541
|
+
"Query"
|
|
542
|
+
],
|
|
516
543
|
"operationId": "create_query",
|
|
517
544
|
"summary": "Create Query",
|
|
518
545
|
"description": "### Create a query.\n\nThis allows you to create a new query that you can later run. Looker queries are immutable once created\nand are not deleted. If you create a query that is exactly like an existing query then the existing query\nwill be returned and no new query will be created. Whether a new query is created or not, you can use\nthe 'id' in the returned query with the 'run' method.\n\nThe query parameters are passed as json in the body of the request.\n\n",
|
|
@@ -578,11 +605,18 @@
|
|
|
578
605
|
},
|
|
579
606
|
"/queries/{query_id}/run/{result_format}": {
|
|
580
607
|
"get": {
|
|
581
|
-
"tags": [
|
|
608
|
+
"tags": [
|
|
609
|
+
"Query"
|
|
610
|
+
],
|
|
582
611
|
"operationId": "run_query",
|
|
583
612
|
"summary": "Run Query",
|
|
584
613
|
"description": "### Run a saved query.\n\nThis runs a previously saved query. You can use this on a query that was generated in the Looker UI\nor one that you have explicitly created using the API. You can also use a query 'id' from a saved 'Look'.\n\nThe 'result_format' parameter specifies the desired structure and format of the response.\n\nSupported formats:\n\n| result_format | Description\n| :-----------: | :--- |\n| json | Plain json\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| md | Simple markdown\n| xlsx | MS Excel spreadsheet\n| sql | Returns the generated SQL rather than running the query\n| png | A PNG image of the visualization of the query\n| jpg | A JPG image of the visualization of the query\n\n\n",
|
|
585
|
-
"produces": [
|
|
614
|
+
"produces": [
|
|
615
|
+
"text",
|
|
616
|
+
"application/json",
|
|
617
|
+
"image/png",
|
|
618
|
+
"image/jpeg"
|
|
619
|
+
],
|
|
586
620
|
"parameters": [
|
|
587
621
|
{
|
|
588
622
|
"name": "query_id",
|
|
@@ -725,11 +759,18 @@
|
|
|
725
759
|
},
|
|
726
760
|
"/queries/run/{result_format}": {
|
|
727
761
|
"post": {
|
|
728
|
-
"tags": [
|
|
762
|
+
"tags": [
|
|
763
|
+
"Query"
|
|
764
|
+
],
|
|
729
765
|
"operationId": "run_inline_query",
|
|
730
766
|
"summary": "Run Inline Query",
|
|
731
767
|
"description": "### Run the query that is specified inline in the posted body.\n\nThis allows running a query as defined in json in the posted body. This combines\nthe two actions of posting & running a query into one step.\n\nHere is an example body in json:\n```\n{\n \"model\":\"thelook\",\n \"view\":\"inventory_items\",\n \"fields\":[\"category.name\",\"inventory_items.days_in_inventory_tier\",\"products.count\"],\n \"filters\":{\"category.name\":\"socks\"},\n \"sorts\":[\"products.count desc 0\"],\n \"limit\":\"500\",\n \"query_timezone\":\"America/Los_Angeles\"\n}\n```\n\nWhen using the Ruby SDK this would be passed as a Ruby hash like:\n```\n{\n :model=>\"thelook\",\n :view=>\"inventory_items\",\n :fields=>\n [\"category.name\",\n \"inventory_items.days_in_inventory_tier\",\n \"products.count\"],\n :filters=>{:\"category.name\"=>\"socks\"},\n :sorts=>[\"products.count desc 0\"],\n :limit=>\"500\",\n :query_timezone=>\"America/Los_Angeles\",\n}\n```\n\nThis will return the result of running the query in the format specified by the 'result_format' parameter.\n\nSupported formats:\n\n| result_format | Description\n| :-----------: | :--- |\n| json | Plain json\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| md | Simple markdown\n| xlsx | MS Excel spreadsheet\n| sql | Returns the generated SQL rather than running the query\n| png | A PNG image of the visualization of the query\n| jpg | A JPG image of the visualization of the query\n\n\n",
|
|
732
|
-
"produces": [
|
|
768
|
+
"produces": [
|
|
769
|
+
"text",
|
|
770
|
+
"application/json",
|
|
771
|
+
"image/png",
|
|
772
|
+
"image/jpeg"
|
|
773
|
+
],
|
|
733
774
|
"parameters": [
|
|
734
775
|
{
|
|
735
776
|
"name": "result_format",
|
|
@@ -873,11 +914,18 @@
|
|
|
873
914
|
},
|
|
874
915
|
"/queries/models/{model_name}/views/{view_name}/run/{result_format}": {
|
|
875
916
|
"get": {
|
|
876
|
-
"tags": [
|
|
917
|
+
"tags": [
|
|
918
|
+
"Query"
|
|
919
|
+
],
|
|
877
920
|
"operationId": "run_url_encoded_query",
|
|
878
921
|
"summary": "Run Url Encoded Query",
|
|
879
922
|
"description": "### Run an URL encoded query.\n\nThis requires the caller to encode the specifiers for the query into the URL query part using\nLooker-specific syntax as explained below.\n\nGenerally, you would want to use one of the methods that takes the parameters as json in the POST body\nfor creating and/or running queries. This method exists for cases where one really needs to encode the\nparameters into the URL of a single 'GET' request. This matches the way that the Looker UI formats\n'explore' URLs etc.\n\nThe parameters here are very similar to the json body formatting except that the filter syntax is\ntricky. Unfortunately, this format makes this method not currently callable via the 'Try it out!' button\nin this documentation page. But, this is callable when creating URLs manually or when using the Looker SDK.\n\nHere is an example inline query URL:\n\n```\nhttps://looker.mycompany.com:19999/api/3.0/queries/models/thelook/views/inventory_items/run/json?fields=category.name,inventory_items.days_in_inventory_tier,products.count&f[category.name]=socks&sorts=products.count+desc+0&limit=500&query_timezone=America/Los_Angeles\n```\n\nWhen invoking this endpoint with the Ruby SDK, pass the query parameter parts as a hash. The hash to match the above would look like:\n\n```ruby\nquery_params =\n{\n :fields => \"category.name,inventory_items.days_in_inventory_tier,products.count\",\n :\"f[category.name]\" => \"socks\",\n :sorts => \"products.count desc 0\",\n :limit => \"500\",\n :query_timezone => \"America/Los_Angeles\"\n}\nresponse = ruby_sdk.run_url_encoded_query('thelook','inventory_items','json', query_params)\n\n```\n\nAgain, it is generally easier to use the variant of this method that passes the full query in the POST body.\nThis method is available for cases where other alternatives won't fit the need.\n\nSupported formats:\n\n| result_format | Description\n| :-----------: | :--- |\n| json | Plain json\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| md | Simple markdown\n| xlsx | MS Excel spreadsheet\n| sql | Returns the generated SQL rather than running the query\n| png | A PNG image of the visualization of the query\n| jpg | A JPG image of the visualization of the query\n\n\n",
|
|
880
|
-
"produces": [
|
|
923
|
+
"produces": [
|
|
924
|
+
"text",
|
|
925
|
+
"application/json",
|
|
926
|
+
"image/png",
|
|
927
|
+
"image/jpeg"
|
|
928
|
+
],
|
|
881
929
|
"parameters": [
|
|
882
930
|
{
|
|
883
931
|
"name": "model_name",
|
|
@@ -939,11 +987,15 @@
|
|
|
939
987
|
},
|
|
940
988
|
"/login": {
|
|
941
989
|
"post": {
|
|
942
|
-
"tags": [
|
|
990
|
+
"tags": [
|
|
991
|
+
"ApiAuth"
|
|
992
|
+
],
|
|
943
993
|
"operationId": "login",
|
|
944
994
|
"summary": "Login",
|
|
945
995
|
"description": "### Present client credentials to obtain an authorization token\n\nLooker API implements the OAuth2 [Resource Owner Password Credentials Grant](https://looker.com/docs/r/api/outh2_resource_owner_pc) pattern.\nThe client credentials required for this login must be obtained by creating an API3 key on a user account\nin the Looker Admin console. The API3 key consists of a public `client_id` and a private `client_secret`.\n\nThe access token returned by `login` must be used in the HTTP Authorization header of subsequent\nAPI requests, like this:\n```\nAuthorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4\n```\nReplace \"4QDkCy...\" with the `access_token` value returned by `login`.\nThe word `token` is a string literal and must be included exactly as shown.\n\nThis function can accept `client_id` and `client_secret` parameters as URL query params or as www-form-urlencoded params in the body of the HTTP request. Since there is a small risk that URL parameters may be visible to intermediate nodes on the network route (proxies, routers, etc), passing credentials in the body of the request is considered more secure than URL params.\n\nExample of passing credentials in the HTTP request body:\n````\nPOST HTTP /login\nContent-Type: application/x-www-form-urlencoded\n\nclient_id=CGc9B7v7J48dQSJvxxx&client_secret=nNVS9cSS3xNpSC9JdsBvvvvv\n````\n\n### Best Practice:\nAlways pass credentials in body params. Pass credentials in URL query params **only** when you cannot pass body params due to application, tool, or other limitations.\n\nFor more information and detailed examples of Looker API authorization, see [How to Authenticate to Looker API3](https://github.com/looker/looker-sdk-ruby/blob/master/authentication.md).\n",
|
|
946
|
-
"consumes": [
|
|
996
|
+
"consumes": [
|
|
997
|
+
"application/x-www-form-urlencoded"
|
|
998
|
+
],
|
|
947
999
|
"parameters": [
|
|
948
1000
|
{
|
|
949
1001
|
"name": "client_id",
|
|
@@ -986,7 +1038,9 @@
|
|
|
986
1038
|
},
|
|
987
1039
|
"/login/{user_id}": {
|
|
988
1040
|
"post": {
|
|
989
|
-
"tags": [
|
|
1041
|
+
"tags": [
|
|
1042
|
+
"ApiAuth"
|
|
1043
|
+
],
|
|
990
1044
|
"operationId": "login_user",
|
|
991
1045
|
"summary": "Login user",
|
|
992
1046
|
"description": "### Create an access token that runs as a given user.\n\nThis can only be called by an authenticated admin user. It allows that admin to generate a new\nauthentication token for the user with the given user id. That token can then be used for subsequent\nAPI calls - which are then performed *as* that target user.\n\nThe target user does *not* need to have a pre-existing API client_id/client_secret pair. And, no such\ncredentials are created by this call.\n\nThis allows for building systems where api user authentication for an arbitrary number of users is done\noutside of Looker and funneled through a single 'service account' with admin permissions. Note that a\nnew access token is generated on each call. If target users are going to be making numerous API\ncalls in a short period then it is wise to cache this authentication token rather than call this before\neach of those API calls.\n\nSee 'login' for more detail on the access token and how to use it.\n",
|
|
@@ -1033,7 +1087,9 @@
|
|
|
1033
1087
|
},
|
|
1034
1088
|
"/logout": {
|
|
1035
1089
|
"delete": {
|
|
1036
|
-
"tags": [
|
|
1090
|
+
"tags": [
|
|
1091
|
+
"ApiAuth"
|
|
1092
|
+
],
|
|
1037
1093
|
"operationId": "logout",
|
|
1038
1094
|
"summary": "Logout",
|
|
1039
1095
|
"description": "### Logout of the API and invalidate the current access token.\n",
|
|
@@ -1063,7 +1119,9 @@
|
|
|
1063
1119
|
},
|
|
1064
1120
|
"/backup_configuration": {
|
|
1065
1121
|
"get": {
|
|
1066
|
-
"tags": [
|
|
1122
|
+
"tags": [
|
|
1123
|
+
"Config"
|
|
1124
|
+
],
|
|
1067
1125
|
"operationId": "backup_configuration",
|
|
1068
1126
|
"summary": "Get Backup Configuration",
|
|
1069
1127
|
"description": "### WARNING: The Looker internal database backup function has been deprecated.\n",
|
|
@@ -1092,7 +1150,9 @@
|
|
|
1092
1150
|
"x-looker-activity-type": "non_query"
|
|
1093
1151
|
},
|
|
1094
1152
|
"patch": {
|
|
1095
|
-
"tags": [
|
|
1153
|
+
"tags": [
|
|
1154
|
+
"Config"
|
|
1155
|
+
],
|
|
1096
1156
|
"operationId": "update_backup_configuration",
|
|
1097
1157
|
"summary": "Update Backup Configuration",
|
|
1098
1158
|
"description": "### WARNING: The Looker internal database backup function has been deprecated.\n",
|
|
@@ -1140,7 +1200,9 @@
|
|
|
1140
1200
|
},
|
|
1141
1201
|
"/cloud_storage": {
|
|
1142
1202
|
"get": {
|
|
1143
|
-
"tags": [
|
|
1203
|
+
"tags": [
|
|
1204
|
+
"Config"
|
|
1205
|
+
],
|
|
1144
1206
|
"operationId": "cloud_storage_configuration",
|
|
1145
1207
|
"summary": "Get Cloud Storage",
|
|
1146
1208
|
"description": "Get the current Cloud Storage Configuration.\n",
|
|
@@ -1168,7 +1230,9 @@
|
|
|
1168
1230
|
"x-looker-activity-type": "non_query"
|
|
1169
1231
|
},
|
|
1170
1232
|
"patch": {
|
|
1171
|
-
"tags": [
|
|
1233
|
+
"tags": [
|
|
1234
|
+
"Config"
|
|
1235
|
+
],
|
|
1172
1236
|
"operationId": "update_cloud_storage_configuration",
|
|
1173
1237
|
"summary": "Update Cloud Storage",
|
|
1174
1238
|
"description": "Update the current Cloud Storage Configuration.\n",
|
|
@@ -1215,7 +1279,9 @@
|
|
|
1215
1279
|
},
|
|
1216
1280
|
"/color_collections": {
|
|
1217
1281
|
"get": {
|
|
1218
|
-
"tags": [
|
|
1282
|
+
"tags": [
|
|
1283
|
+
"ColorCollection"
|
|
1284
|
+
],
|
|
1219
1285
|
"operationId": "all_color_collections",
|
|
1220
1286
|
"summary": "Get all Color Collections",
|
|
1221
1287
|
"description": "### Get an array of all existing Color Collections\nGet a **single** color collection by id with [ColorCollection](#!/ColorCollection/color_collection)\n\nGet all **standard** color collections with [ColorCollection](#!/ColorCollection/color_collections_standard)\n\nGet all **custom** color collections with [ColorCollection](#!/ColorCollection/color_collections_custom)\n\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1255,7 +1321,9 @@
|
|
|
1255
1321
|
"x-looker-activity-type": "non_query"
|
|
1256
1322
|
},
|
|
1257
1323
|
"post": {
|
|
1258
|
-
"tags": [
|
|
1324
|
+
"tags": [
|
|
1325
|
+
"ColorCollection"
|
|
1326
|
+
],
|
|
1259
1327
|
"operationId": "create_color_collection",
|
|
1260
1328
|
"summary": "Create ColorCollection",
|
|
1261
1329
|
"description": "### Create a custom color collection with the specified information\n\nCreates a new custom color collection object, returning the details, including the created id.\n\n**Update** an existing color collection with [Update Color Collection](#!/ColorCollection/update_color_collection)\n\n**Permanently delete** an existing custom color collection with [Delete Color Collection](#!/ColorCollection/delete_color_collection)\n\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1320,7 +1388,9 @@
|
|
|
1320
1388
|
},
|
|
1321
1389
|
"/color_collections/custom": {
|
|
1322
1390
|
"get": {
|
|
1323
|
-
"tags": [
|
|
1391
|
+
"tags": [
|
|
1392
|
+
"ColorCollection"
|
|
1393
|
+
],
|
|
1324
1394
|
"operationId": "color_collections_custom",
|
|
1325
1395
|
"summary": "Get all Custom Color Collections",
|
|
1326
1396
|
"description": "### Get an array of all existing **Custom** Color Collections\nGet a **single** color collection by id with [ColorCollection](#!/ColorCollection/color_collection)\n\nGet all **standard** color collections with [ColorCollection](#!/ColorCollection/color_collections_standard)\n\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1362,7 +1432,9 @@
|
|
|
1362
1432
|
},
|
|
1363
1433
|
"/color_collections/standard": {
|
|
1364
1434
|
"get": {
|
|
1365
|
-
"tags": [
|
|
1435
|
+
"tags": [
|
|
1436
|
+
"ColorCollection"
|
|
1437
|
+
],
|
|
1366
1438
|
"operationId": "color_collections_standard",
|
|
1367
1439
|
"summary": "Get all Standard Color Collections",
|
|
1368
1440
|
"description": "### Get an array of all existing **Standard** Color Collections\nGet a **single** color collection by id with [ColorCollection](#!/ColorCollection/color_collection)\n\nGet all **custom** color collections with [ColorCollection](#!/ColorCollection/color_collections_custom)\n\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1404,7 +1476,9 @@
|
|
|
1404
1476
|
},
|
|
1405
1477
|
"/color_collections/default": {
|
|
1406
1478
|
"put": {
|
|
1407
|
-
"tags": [
|
|
1479
|
+
"tags": [
|
|
1480
|
+
"ColorCollection"
|
|
1481
|
+
],
|
|
1408
1482
|
"operationId": "set_default_color_collection",
|
|
1409
1483
|
"summary": "Set Default Color Collection",
|
|
1410
1484
|
"description": "### Set the global default Color Collection by ID\n\nReturns the new specified default Color Collection object.\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1453,7 +1527,9 @@
|
|
|
1453
1527
|
"x-looker-activity-type": "non_query"
|
|
1454
1528
|
},
|
|
1455
1529
|
"get": {
|
|
1456
|
-
"tags": [
|
|
1530
|
+
"tags": [
|
|
1531
|
+
"ColorCollection"
|
|
1532
|
+
],
|
|
1457
1533
|
"operationId": "default_color_collection",
|
|
1458
1534
|
"summary": "Get Default Color Collection",
|
|
1459
1535
|
"description": "### Get the default color collection\n\nUse this to retrieve the default Color Collection.\n\nSet the default color collection with [ColorCollection](#!/ColorCollection/set_default_color_collection)\n",
|
|
@@ -1483,7 +1559,9 @@
|
|
|
1483
1559
|
},
|
|
1484
1560
|
"/color_collections/{collection_id}": {
|
|
1485
1561
|
"get": {
|
|
1486
|
-
"tags": [
|
|
1562
|
+
"tags": [
|
|
1563
|
+
"ColorCollection"
|
|
1564
|
+
],
|
|
1487
1565
|
"operationId": "color_collection",
|
|
1488
1566
|
"summary": "Get Color Collection by ID",
|
|
1489
1567
|
"description": "### Get a Color Collection by ID\n\nUse this to retrieve a specific Color Collection.\nGet a **single** color collection by id with [ColorCollection](#!/ColorCollection/color_collection)\n\nGet all **standard** color collections with [ColorCollection](#!/ColorCollection/color_collections_standard)\n\nGet all **custom** color collections with [ColorCollection](#!/ColorCollection/color_collections_custom)\n\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1527,7 +1605,9 @@
|
|
|
1527
1605
|
"x-looker-activity-type": "non_query"
|
|
1528
1606
|
},
|
|
1529
1607
|
"patch": {
|
|
1530
|
-
"tags": [
|
|
1608
|
+
"tags": [
|
|
1609
|
+
"ColorCollection"
|
|
1610
|
+
],
|
|
1531
1611
|
"operationId": "update_color_collection",
|
|
1532
1612
|
"summary": "Update Custom Color collection",
|
|
1533
1613
|
"description": "### Update a custom color collection by id.\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1591,7 +1671,9 @@
|
|
|
1591
1671
|
"x-looker-activity-type": "non_query"
|
|
1592
1672
|
},
|
|
1593
1673
|
"delete": {
|
|
1594
|
-
"tags": [
|
|
1674
|
+
"tags": [
|
|
1675
|
+
"ColorCollection"
|
|
1676
|
+
],
|
|
1595
1677
|
"operationId": "delete_color_collection",
|
|
1596
1678
|
"summary": "Delete ColorCollection",
|
|
1597
1679
|
"description": "### Delete a custom color collection by id\n\nThis operation permanently deletes the identified **Custom** color collection.\n\n**Standard** color collections cannot be deleted\n\nBecause multiple color collections can have the same label, they must be deleted by ID, not name.\n**Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.\n\n",
|
|
@@ -1645,7 +1727,9 @@
|
|
|
1645
1727
|
},
|
|
1646
1728
|
"/content_favorite/search": {
|
|
1647
1729
|
"get": {
|
|
1648
|
-
"tags": [
|
|
1730
|
+
"tags": [
|
|
1731
|
+
"Content"
|
|
1732
|
+
],
|
|
1649
1733
|
"operationId": "search_content_favorites",
|
|
1650
1734
|
"summary": "Search Favorite Contents",
|
|
1651
1735
|
"description": "### Search Favorite Content\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -1757,7 +1841,9 @@
|
|
|
1757
1841
|
},
|
|
1758
1842
|
"/content_favorite/{content_favorite_id}": {
|
|
1759
1843
|
"get": {
|
|
1760
|
-
"tags": [
|
|
1844
|
+
"tags": [
|
|
1845
|
+
"Content"
|
|
1846
|
+
],
|
|
1761
1847
|
"operationId": "content_favorite",
|
|
1762
1848
|
"summary": "Get Favorite Content",
|
|
1763
1849
|
"description": "### Get favorite content by its id",
|
|
@@ -1802,7 +1888,9 @@
|
|
|
1802
1888
|
"x-looker-activity-type": "non_query"
|
|
1803
1889
|
},
|
|
1804
1890
|
"delete": {
|
|
1805
|
-
"tags": [
|
|
1891
|
+
"tags": [
|
|
1892
|
+
"Content"
|
|
1893
|
+
],
|
|
1806
1894
|
"operationId": "delete_content_favorite",
|
|
1807
1895
|
"summary": "Delete Favorite Content",
|
|
1808
1896
|
"description": "### Delete favorite content",
|
|
@@ -1848,7 +1936,9 @@
|
|
|
1848
1936
|
},
|
|
1849
1937
|
"/content_favorite": {
|
|
1850
1938
|
"post": {
|
|
1851
|
-
"tags": [
|
|
1939
|
+
"tags": [
|
|
1940
|
+
"Content"
|
|
1941
|
+
],
|
|
1852
1942
|
"operationId": "create_content_favorite",
|
|
1853
1943
|
"summary": "Create Favorite Content",
|
|
1854
1944
|
"description": "### Create favorite content",
|
|
@@ -1907,7 +1997,9 @@
|
|
|
1907
1997
|
},
|
|
1908
1998
|
"/content_metadata": {
|
|
1909
1999
|
"get": {
|
|
1910
|
-
"tags": [
|
|
2000
|
+
"tags": [
|
|
2001
|
+
"Content"
|
|
2002
|
+
],
|
|
1911
2003
|
"operationId": "all_content_metadatas",
|
|
1912
2004
|
"summary": "Get All Content Metadatas",
|
|
1913
2005
|
"description": "### Get information about all content metadata in a space.\n",
|
|
@@ -1957,7 +2049,9 @@
|
|
|
1957
2049
|
},
|
|
1958
2050
|
"/content_metadata/{content_metadata_id}": {
|
|
1959
2051
|
"patch": {
|
|
1960
|
-
"tags": [
|
|
2052
|
+
"tags": [
|
|
2053
|
+
"Content"
|
|
2054
|
+
],
|
|
1961
2055
|
"operationId": "update_content_metadata",
|
|
1962
2056
|
"summary": "Update Content Metadata",
|
|
1963
2057
|
"description": "### Move a piece of content.\n",
|
|
@@ -2016,7 +2110,9 @@
|
|
|
2016
2110
|
"x-looker-activity-type": "non_query"
|
|
2017
2111
|
},
|
|
2018
2112
|
"get": {
|
|
2019
|
-
"tags": [
|
|
2113
|
+
"tags": [
|
|
2114
|
+
"Content"
|
|
2115
|
+
],
|
|
2020
2116
|
"operationId": "content_metadata",
|
|
2021
2117
|
"summary": "Get Content Metadata",
|
|
2022
2118
|
"description": "### Get information about an individual content metadata record.\n",
|
|
@@ -2063,7 +2159,9 @@
|
|
|
2063
2159
|
},
|
|
2064
2160
|
"/content_metadata_access": {
|
|
2065
2161
|
"post": {
|
|
2066
|
-
"tags": [
|
|
2162
|
+
"tags": [
|
|
2163
|
+
"Content"
|
|
2164
|
+
],
|
|
2067
2165
|
"operationId": "create_content_metadata_access",
|
|
2068
2166
|
"summary": "Create Content Metadata Access",
|
|
2069
2167
|
"description": "### Create content metadata access.\n",
|
|
@@ -2128,7 +2226,9 @@
|
|
|
2128
2226
|
"x-looker-rate-limited": true
|
|
2129
2227
|
},
|
|
2130
2228
|
"get": {
|
|
2131
|
-
"tags": [
|
|
2229
|
+
"tags": [
|
|
2230
|
+
"Content"
|
|
2231
|
+
],
|
|
2132
2232
|
"operationId": "all_content_metadata_accesses",
|
|
2133
2233
|
"summary": "Get All Content Metadata Accesses",
|
|
2134
2234
|
"description": "### All content metadata access records for a content metadata item.\n",
|
|
@@ -2178,7 +2278,9 @@
|
|
|
2178
2278
|
},
|
|
2179
2279
|
"/content_metadata_access/{content_metadata_access_id}": {
|
|
2180
2280
|
"put": {
|
|
2181
|
-
"tags": [
|
|
2281
|
+
"tags": [
|
|
2282
|
+
"Content"
|
|
2283
|
+
],
|
|
2182
2284
|
"operationId": "update_content_metadata_access",
|
|
2183
2285
|
"summary": "Update Content Metadata Access",
|
|
2184
2286
|
"description": "### Update type of access for content metadata.\n",
|
|
@@ -2237,7 +2339,9 @@
|
|
|
2237
2339
|
"x-looker-activity-type": "non_query"
|
|
2238
2340
|
},
|
|
2239
2341
|
"delete": {
|
|
2240
|
-
"tags": [
|
|
2342
|
+
"tags": [
|
|
2343
|
+
"Content"
|
|
2344
|
+
],
|
|
2241
2345
|
"operationId": "delete_content_metadata_access",
|
|
2242
2346
|
"summary": "Delete Content Metadata Access",
|
|
2243
2347
|
"description": "### Remove content metadata access.\n",
|
|
@@ -2283,11 +2387,16 @@
|
|
|
2283
2387
|
},
|
|
2284
2388
|
"/content_thumbnail/{type}/{resource_id}": {
|
|
2285
2389
|
"get": {
|
|
2286
|
-
"tags": [
|
|
2390
|
+
"tags": [
|
|
2391
|
+
"Content"
|
|
2392
|
+
],
|
|
2287
2393
|
"operationId": "content_thumbnail",
|
|
2288
2394
|
"summary": "Get Content Thumbnail",
|
|
2289
2395
|
"description": "### Get an image representing the contents of a dashboard or look.\n\nThe returned thumbnail is an abstract representation of the contents of a dashbord or look and does not\nreflect the actual data displayed in the respective visualizations.\n",
|
|
2290
|
-
"produces": [
|
|
2396
|
+
"produces": [
|
|
2397
|
+
"image/svg+xml",
|
|
2398
|
+
"image/png"
|
|
2399
|
+
],
|
|
2291
2400
|
"parameters": [
|
|
2292
2401
|
{
|
|
2293
2402
|
"name": "type",
|
|
@@ -2360,7 +2469,9 @@
|
|
|
2360
2469
|
},
|
|
2361
2470
|
"/content_validation": {
|
|
2362
2471
|
"get": {
|
|
2363
|
-
"tags": [
|
|
2472
|
+
"tags": [
|
|
2473
|
+
"Content"
|
|
2474
|
+
],
|
|
2364
2475
|
"operationId": "content_validation",
|
|
2365
2476
|
"summary": "Validate Content",
|
|
2366
2477
|
"description": "### Validate All Content\n\nPerforms validation of all looks and dashboards\nReturns a list of errors found as well as metadata about the content validation run.\n",
|
|
@@ -2411,7 +2522,9 @@
|
|
|
2411
2522
|
},
|
|
2412
2523
|
"/content_view/search": {
|
|
2413
2524
|
"get": {
|
|
2414
|
-
"tags": [
|
|
2525
|
+
"tags": [
|
|
2526
|
+
"Content"
|
|
2527
|
+
],
|
|
2415
2528
|
"operationId": "search_content_views",
|
|
2416
2529
|
"summary": "Search Content Views",
|
|
2417
2530
|
"description": "### Search Content Views\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -2543,7 +2656,9 @@
|
|
|
2543
2656
|
},
|
|
2544
2657
|
"/custom_welcome_email": {
|
|
2545
2658
|
"get": {
|
|
2546
|
-
"tags": [
|
|
2659
|
+
"tags": [
|
|
2660
|
+
"Config"
|
|
2661
|
+
],
|
|
2547
2662
|
"operationId": "custom_welcome_email",
|
|
2548
2663
|
"summary": "Get Custom Welcome Email",
|
|
2549
2664
|
"description": "### Get the current status and content of custom welcome emails\n",
|
|
@@ -2571,7 +2686,9 @@
|
|
|
2571
2686
|
"x-looker-activity-type": "non_query"
|
|
2572
2687
|
},
|
|
2573
2688
|
"patch": {
|
|
2574
|
-
"tags": [
|
|
2689
|
+
"tags": [
|
|
2690
|
+
"Config"
|
|
2691
|
+
],
|
|
2575
2692
|
"operationId": "update_custom_welcome_email",
|
|
2576
2693
|
"summary": "Update Custom Welcome Email Content",
|
|
2577
2694
|
"description": "Update custom welcome email setting and values. Optionally send a test email with the new content to the currently logged in user.\n",
|
|
@@ -2631,7 +2748,9 @@
|
|
|
2631
2748
|
},
|
|
2632
2749
|
"/custom_welcome_email_test": {
|
|
2633
2750
|
"put": {
|
|
2634
|
-
"tags": [
|
|
2751
|
+
"tags": [
|
|
2752
|
+
"Config"
|
|
2753
|
+
],
|
|
2635
2754
|
"operationId": "update_custom_welcome_email_test",
|
|
2636
2755
|
"summary": "Send a test welcome email to the currently logged in user with the supplied content ",
|
|
2637
2756
|
"description": "Requests to this endpoint will send a welcome email with the custom content provided in the body to the currently logged in user.\n",
|
|
@@ -2684,7 +2803,9 @@
|
|
|
2684
2803
|
},
|
|
2685
2804
|
"/dashboards": {
|
|
2686
2805
|
"get": {
|
|
2687
|
-
"tags": [
|
|
2806
|
+
"tags": [
|
|
2807
|
+
"Dashboard"
|
|
2808
|
+
],
|
|
2688
2809
|
"operationId": "all_dashboards",
|
|
2689
2810
|
"summary": "Get All Dashboards",
|
|
2690
2811
|
"description": "### Get information about all active dashboards.\n\nReturns an array of **abbreviated dashboard objects**. Dashboards marked as deleted are excluded from this list.\n\nGet the **full details** of a specific dashboard by id with [dashboard()](#!/Dashboard/dashboard)\n\nFind **deleted dashboards** with [search_dashboards()](#!/Dashboard/search_dashboards)\n",
|
|
@@ -2724,7 +2845,9 @@
|
|
|
2724
2845
|
"x-looker-activity-type": "non_query"
|
|
2725
2846
|
},
|
|
2726
2847
|
"post": {
|
|
2727
|
-
"tags": [
|
|
2848
|
+
"tags": [
|
|
2849
|
+
"Dashboard"
|
|
2850
|
+
],
|
|
2728
2851
|
"operationId": "create_dashboard",
|
|
2729
2852
|
"summary": "Create Dashboard",
|
|
2730
2853
|
"description": "### Create a new dashboard\n\nCreates a new dashboard object and returns the details of the newly created dashboard.\n\n`Title`, `user_id`, and `space_id` are all required fields.\n`Space_id` and `user_id` must contain the id of an existing space or user, respectively.\nA dashboard's `title` must be unique within the space in which it resides.\n\nIf you receive a 422 error response when creating a dashboard, be sure to look at the\nresponse body for information about exactly which fields are missing or contain invalid data.\n\nYou can **update** an existing dashboard with [update_dashboard()](#!/Dashboard/update_dashboard)\n\nYou can **permanently delete** an existing dashboard with [delete_dashboard()](#!/Dashboard/delete_dashboard)\n",
|
|
@@ -2783,7 +2906,9 @@
|
|
|
2783
2906
|
},
|
|
2784
2907
|
"/dashboards/search": {
|
|
2785
2908
|
"get": {
|
|
2786
|
-
"tags": [
|
|
2909
|
+
"tags": [
|
|
2910
|
+
"Dashboard"
|
|
2911
|
+
],
|
|
2787
2912
|
"operationId": "search_dashboards",
|
|
2788
2913
|
"summary": "Search Dashboards",
|
|
2789
2914
|
"description": "### Search Dashboards\n\nReturns an **array of dashboard objects** that match the specified search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n\nThe parameters `limit`, and `offset` are recommended for fetching results in page-size chunks.\n\nGet a **single dashboard** by id with [dashboard()](#!/Dashboard/dashboard)\n",
|
|
@@ -2958,7 +3083,9 @@
|
|
|
2958
3083
|
},
|
|
2959
3084
|
"/dashboards/{lookml_dashboard_id}/import/{space_id}": {
|
|
2960
3085
|
"post": {
|
|
2961
|
-
"tags": [
|
|
3086
|
+
"tags": [
|
|
3087
|
+
"Dashboard"
|
|
3088
|
+
],
|
|
2962
3089
|
"operationId": "import_lookml_dashboard",
|
|
2963
3090
|
"summary": "Import LookML Dashboard",
|
|
2964
3091
|
"description": "### Import a LookML dashboard to a space as a UDD\nCreates a UDD (a dashboard which exists in the Looker database rather than as a LookML file) from the LookML dashboard\nand places it in the space specified. The created UDD will have a lookml_link_id which links to the original LookML dashboard.\n\nTo give the imported dashboard specify a (e.g. title: \"my title\") in the body of your request, otherwise the imported\ndashboard will have the same title as the original LookML dashboard.\n\nFor this operation to succeed the user must have permission to see the LookML dashboard in question, and have permission to\ncreate content in the space the dashboard is being imported to.\n\n**Sync** a linked UDD with [sync_lookml_dashboard()](#!/Dashboard/sync_lookml_dashboard)\n**Unlink** a linked UDD by setting lookml_link_id to null with [update_dashboard()](#!/Dashboard/update_dashboard)\n",
|
|
@@ -3044,7 +3171,9 @@
|
|
|
3044
3171
|
},
|
|
3045
3172
|
"/dashboards/{lookml_dashboard_id}/sync": {
|
|
3046
3173
|
"patch": {
|
|
3047
|
-
"tags": [
|
|
3174
|
+
"tags": [
|
|
3175
|
+
"Dashboard"
|
|
3176
|
+
],
|
|
3048
3177
|
"operationId": "sync_lookml_dashboard",
|
|
3049
3178
|
"summary": "Sync LookML Dashboard",
|
|
3050
3179
|
"description": "### Update all linked dashboards to match the specified LookML dashboard.\n\nAny UDD (a dashboard which exists in the Looker database rather than as a LookML file) which has a `lookml_link_id`\nproperty value referring to a LookML dashboard's id (model::dashboardname) will be updated so that it matches the current state of the LookML dashboard.\n\nFor this operation to succeed the user must have permission to view the LookML dashboard, and only linked dashboards\nthat the user has permission to update will be synced.\n\nTo **link** or **unlink** a UDD set the `lookml_link_id` property with [update_dashboard()](#!/Dashboard/update_dashboard)\n",
|
|
@@ -3115,7 +3244,9 @@
|
|
|
3115
3244
|
},
|
|
3116
3245
|
"/dashboards/{dashboard_id}": {
|
|
3117
3246
|
"delete": {
|
|
3118
|
-
"tags": [
|
|
3247
|
+
"tags": [
|
|
3248
|
+
"Dashboard"
|
|
3249
|
+
],
|
|
3119
3250
|
"operationId": "delete_dashboard",
|
|
3120
3251
|
"summary": "Delete Dashboard",
|
|
3121
3252
|
"description": "### Delete the dashboard with the specified id\n\nPermanently **deletes** a dashboard. (The dashboard cannot be recovered after this operation.)\n\n\"Soft\" delete or hide a dashboard by setting its `deleted` status to `True` with [update_dashboard()](#!/Dashboard/update_dashboard).\n\nNote: When a dashboard is deleted in the UI, it is soft deleted. Use this API call to permanently remove it, if desired.\n",
|
|
@@ -3164,7 +3295,9 @@
|
|
|
3164
3295
|
"x-looker-activity-type": "non_query"
|
|
3165
3296
|
},
|
|
3166
3297
|
"patch": {
|
|
3167
|
-
"tags": [
|
|
3298
|
+
"tags": [
|
|
3299
|
+
"Dashboard"
|
|
3300
|
+
],
|
|
3168
3301
|
"operationId": "update_dashboard",
|
|
3169
3302
|
"summary": "Update Dashboard",
|
|
3170
3303
|
"description": "### Update a dashboard\n\nYou can use this function to change the string and integer properties of\na dashboard. Nested objects such as filters, dashboard elements, or dashboard layout components\ncannot be modified by this function - use the update functions for the respective\nnested object types (like [update_dashboard_filter()](#!/3.1/Dashboard/update_dashboard_filter) to change a filter)\nto modify nested objects referenced by a dashboard.\n\nIf you receive a 422 error response when updating a dashboard, be sure to look at the\nresponse body for information about exactly which fields are missing or contain invalid data.\n",
|
|
@@ -3228,7 +3361,9 @@
|
|
|
3228
3361
|
"x-looker-activity-type": "non_query"
|
|
3229
3362
|
},
|
|
3230
3363
|
"get": {
|
|
3231
|
-
"tags": [
|
|
3364
|
+
"tags": [
|
|
3365
|
+
"Dashboard"
|
|
3366
|
+
],
|
|
3232
3367
|
"operationId": "dashboard",
|
|
3233
3368
|
"summary": "Get Dashboard",
|
|
3234
3369
|
"description": "### Get information about a dashboard\n\nReturns the full details of the identified dashboard object\n\nGet a **summary list** of all active dashboards with [all_dashboards()](#!/Dashboard/all_dashboards)\n\nYou can **Search** for dashboards with [search_dashboards()](#!/Dashboard/search_dashboards)\n",
|
|
@@ -3274,7 +3409,9 @@
|
|
|
3274
3409
|
},
|
|
3275
3410
|
"/dashboards/aggregate_table_lookml/{dashboard_id}": {
|
|
3276
3411
|
"get": {
|
|
3277
|
-
"tags": [
|
|
3412
|
+
"tags": [
|
|
3413
|
+
"Dashboard"
|
|
3414
|
+
],
|
|
3278
3415
|
"operationId": "dashboard_aggregate_table_lookml",
|
|
3279
3416
|
"summary": "Get Aggregate Table LookML for a dashboard",
|
|
3280
3417
|
"description": "### Get Aggregate Table LookML for Each Query on a Dahboard\n\nReturns a JSON object that contains the dashboard id and Aggregate Table lookml\n\n",
|
|
@@ -3313,7 +3450,9 @@
|
|
|
3313
3450
|
},
|
|
3314
3451
|
"/dashboards/lookml/{dashboard_id}": {
|
|
3315
3452
|
"get": {
|
|
3316
|
-
"tags": [
|
|
3453
|
+
"tags": [
|
|
3454
|
+
"Dashboard"
|
|
3455
|
+
],
|
|
3317
3456
|
"operationId": "dashboard_lookml",
|
|
3318
3457
|
"summary": "Get lookml of a UDD",
|
|
3319
3458
|
"description": "### Get lookml of a UDD\n\nReturns a JSON object that contains the dashboard id and the full lookml\n\n",
|
|
@@ -3352,7 +3491,9 @@
|
|
|
3352
3491
|
},
|
|
3353
3492
|
"/dashboard_elements/search": {
|
|
3354
3493
|
"get": {
|
|
3355
|
-
"tags": [
|
|
3494
|
+
"tags": [
|
|
3495
|
+
"Dashboard"
|
|
3496
|
+
],
|
|
3356
3497
|
"operationId": "search_dashboard_elements",
|
|
3357
3498
|
"summary": "Search Dashboard Elements",
|
|
3358
3499
|
"description": "### Search Dashboard Elements\n\nReturns an **array of DashboardElement objects** that match the specified search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -3438,7 +3579,9 @@
|
|
|
3438
3579
|
},
|
|
3439
3580
|
"/dashboard_elements/{dashboard_element_id}": {
|
|
3440
3581
|
"get": {
|
|
3441
|
-
"tags": [
|
|
3582
|
+
"tags": [
|
|
3583
|
+
"Dashboard"
|
|
3584
|
+
],
|
|
3442
3585
|
"operationId": "dashboard_element",
|
|
3443
3586
|
"summary": "Get DashboardElement",
|
|
3444
3587
|
"description": "### Get information about the dashboard element with a specific id.",
|
|
@@ -3482,7 +3625,9 @@
|
|
|
3482
3625
|
"x-looker-activity-type": "non_query"
|
|
3483
3626
|
},
|
|
3484
3627
|
"delete": {
|
|
3485
|
-
"tags": [
|
|
3628
|
+
"tags": [
|
|
3629
|
+
"Dashboard"
|
|
3630
|
+
],
|
|
3486
3631
|
"operationId": "delete_dashboard_element",
|
|
3487
3632
|
"summary": "Delete DashboardElement",
|
|
3488
3633
|
"description": "### Delete a dashboard element with a specific id.",
|
|
@@ -3525,7 +3670,9 @@
|
|
|
3525
3670
|
"x-looker-activity-type": "non_query"
|
|
3526
3671
|
},
|
|
3527
3672
|
"patch": {
|
|
3528
|
-
"tags": [
|
|
3673
|
+
"tags": [
|
|
3674
|
+
"Dashboard"
|
|
3675
|
+
],
|
|
3529
3676
|
"operationId": "update_dashboard_element",
|
|
3530
3677
|
"summary": "Update DashboardElement",
|
|
3531
3678
|
"description": "### Update the dashboard element with a specific id.",
|
|
@@ -3592,7 +3739,9 @@
|
|
|
3592
3739
|
},
|
|
3593
3740
|
"/dashboards/{dashboard_id}/dashboard_elements": {
|
|
3594
3741
|
"get": {
|
|
3595
|
-
"tags": [
|
|
3742
|
+
"tags": [
|
|
3743
|
+
"Dashboard"
|
|
3744
|
+
],
|
|
3596
3745
|
"operationId": "dashboard_dashboard_elements",
|
|
3597
3746
|
"summary": "Get All DashboardElements",
|
|
3598
3747
|
"description": "### Get information about all the dashboard elements on a dashboard with a specific id.",
|
|
@@ -3641,7 +3790,9 @@
|
|
|
3641
3790
|
},
|
|
3642
3791
|
"/dashboard_elements": {
|
|
3643
3792
|
"post": {
|
|
3644
|
-
"tags": [
|
|
3793
|
+
"tags": [
|
|
3794
|
+
"Dashboard"
|
|
3795
|
+
],
|
|
3645
3796
|
"operationId": "create_dashboard_element",
|
|
3646
3797
|
"summary": "Create DashboardElement",
|
|
3647
3798
|
"description": "### Create a dashboard element on the dashboard with a specific id.",
|
|
@@ -3707,7 +3858,9 @@
|
|
|
3707
3858
|
},
|
|
3708
3859
|
"/dashboard_filters/{dashboard_filter_id}": {
|
|
3709
3860
|
"get": {
|
|
3710
|
-
"tags": [
|
|
3861
|
+
"tags": [
|
|
3862
|
+
"Dashboard"
|
|
3863
|
+
],
|
|
3711
3864
|
"operationId": "dashboard_filter",
|
|
3712
3865
|
"summary": "Get Dashboard Filter",
|
|
3713
3866
|
"description": "### Get information about the dashboard filters with a specific id.",
|
|
@@ -3751,7 +3904,9 @@
|
|
|
3751
3904
|
"x-looker-activity-type": "non_query"
|
|
3752
3905
|
},
|
|
3753
3906
|
"delete": {
|
|
3754
|
-
"tags": [
|
|
3907
|
+
"tags": [
|
|
3908
|
+
"Dashboard"
|
|
3909
|
+
],
|
|
3755
3910
|
"operationId": "delete_dashboard_filter",
|
|
3756
3911
|
"summary": "Delete Dashboard Filter",
|
|
3757
3912
|
"description": "### Delete a dashboard filter with a specific id.",
|
|
@@ -3794,7 +3949,9 @@
|
|
|
3794
3949
|
"x-looker-activity-type": "non_query"
|
|
3795
3950
|
},
|
|
3796
3951
|
"patch": {
|
|
3797
|
-
"tags": [
|
|
3952
|
+
"tags": [
|
|
3953
|
+
"Dashboard"
|
|
3954
|
+
],
|
|
3798
3955
|
"operationId": "update_dashboard_filter",
|
|
3799
3956
|
"summary": "Update Dashboard Filter",
|
|
3800
3957
|
"description": "### Update the dashboard filter with a specific id.",
|
|
@@ -3861,7 +4018,9 @@
|
|
|
3861
4018
|
},
|
|
3862
4019
|
"/dashboards/{dashboard_id}/dashboard_filters": {
|
|
3863
4020
|
"get": {
|
|
3864
|
-
"tags": [
|
|
4021
|
+
"tags": [
|
|
4022
|
+
"Dashboard"
|
|
4023
|
+
],
|
|
3865
4024
|
"operationId": "dashboard_dashboard_filters",
|
|
3866
4025
|
"summary": "Get All Dashboard Filters",
|
|
3867
4026
|
"description": "### Get information about all the dashboard filters on a dashboard with a specific id.",
|
|
@@ -3910,7 +4069,9 @@
|
|
|
3910
4069
|
},
|
|
3911
4070
|
"/dashboard_filters": {
|
|
3912
4071
|
"post": {
|
|
3913
|
-
"tags": [
|
|
4072
|
+
"tags": [
|
|
4073
|
+
"Dashboard"
|
|
4074
|
+
],
|
|
3914
4075
|
"operationId": "create_dashboard_filter",
|
|
3915
4076
|
"summary": "Create Dashboard Filter",
|
|
3916
4077
|
"description": "### Create a dashboard filter on the dashboard with a specific id.",
|
|
@@ -3976,7 +4137,9 @@
|
|
|
3976
4137
|
},
|
|
3977
4138
|
"/dashboard_layout_components/{dashboard_layout_component_id}": {
|
|
3978
4139
|
"get": {
|
|
3979
|
-
"tags": [
|
|
4140
|
+
"tags": [
|
|
4141
|
+
"Dashboard"
|
|
4142
|
+
],
|
|
3980
4143
|
"operationId": "dashboard_layout_component",
|
|
3981
4144
|
"summary": "Get DashboardLayoutComponent",
|
|
3982
4145
|
"description": "### Get information about the dashboard elements with a specific id.",
|
|
@@ -4020,7 +4183,9 @@
|
|
|
4020
4183
|
"x-looker-activity-type": "non_query"
|
|
4021
4184
|
},
|
|
4022
4185
|
"patch": {
|
|
4023
|
-
"tags": [
|
|
4186
|
+
"tags": [
|
|
4187
|
+
"Dashboard"
|
|
4188
|
+
],
|
|
4024
4189
|
"operationId": "update_dashboard_layout_component",
|
|
4025
4190
|
"summary": "Update DashboardLayoutComponent",
|
|
4026
4191
|
"description": "### Update the dashboard element with a specific id.",
|
|
@@ -4087,7 +4252,9 @@
|
|
|
4087
4252
|
},
|
|
4088
4253
|
"/dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components": {
|
|
4089
4254
|
"get": {
|
|
4090
|
-
"tags": [
|
|
4255
|
+
"tags": [
|
|
4256
|
+
"Dashboard"
|
|
4257
|
+
],
|
|
4091
4258
|
"operationId": "dashboard_layout_dashboard_layout_components",
|
|
4092
4259
|
"summary": "Get All DashboardLayoutComponents",
|
|
4093
4260
|
"description": "### Get information about all the dashboard layout components for a dashboard layout with a specific id.",
|
|
@@ -4136,7 +4303,9 @@
|
|
|
4136
4303
|
},
|
|
4137
4304
|
"/dashboard_layouts/{dashboard_layout_id}": {
|
|
4138
4305
|
"get": {
|
|
4139
|
-
"tags": [
|
|
4306
|
+
"tags": [
|
|
4307
|
+
"Dashboard"
|
|
4308
|
+
],
|
|
4140
4309
|
"operationId": "dashboard_layout",
|
|
4141
4310
|
"summary": "Get DashboardLayout",
|
|
4142
4311
|
"description": "### Get information about the dashboard layouts with a specific id.",
|
|
@@ -4180,7 +4349,9 @@
|
|
|
4180
4349
|
"x-looker-activity-type": "non_query"
|
|
4181
4350
|
},
|
|
4182
4351
|
"delete": {
|
|
4183
|
-
"tags": [
|
|
4352
|
+
"tags": [
|
|
4353
|
+
"Dashboard"
|
|
4354
|
+
],
|
|
4184
4355
|
"operationId": "delete_dashboard_layout",
|
|
4185
4356
|
"summary": "Delete DashboardLayout",
|
|
4186
4357
|
"description": "### Delete a dashboard layout with a specific id.",
|
|
@@ -4229,7 +4400,9 @@
|
|
|
4229
4400
|
"x-looker-activity-type": "non_query"
|
|
4230
4401
|
},
|
|
4231
4402
|
"patch": {
|
|
4232
|
-
"tags": [
|
|
4403
|
+
"tags": [
|
|
4404
|
+
"Dashboard"
|
|
4405
|
+
],
|
|
4233
4406
|
"operationId": "update_dashboard_layout",
|
|
4234
4407
|
"summary": "Update DashboardLayout",
|
|
4235
4408
|
"description": "### Update the dashboard layout with a specific id.",
|
|
@@ -4296,7 +4469,9 @@
|
|
|
4296
4469
|
},
|
|
4297
4470
|
"/dashboards/{dashboard_id}/dashboard_layouts": {
|
|
4298
4471
|
"get": {
|
|
4299
|
-
"tags": [
|
|
4472
|
+
"tags": [
|
|
4473
|
+
"Dashboard"
|
|
4474
|
+
],
|
|
4300
4475
|
"operationId": "dashboard_dashboard_layouts",
|
|
4301
4476
|
"summary": "Get All DashboardLayouts",
|
|
4302
4477
|
"description": "### Get information about all the dashboard elements on a dashboard with a specific id.",
|
|
@@ -4345,7 +4520,9 @@
|
|
|
4345
4520
|
},
|
|
4346
4521
|
"/dashboard_layouts": {
|
|
4347
4522
|
"post": {
|
|
4348
|
-
"tags": [
|
|
4523
|
+
"tags": [
|
|
4524
|
+
"Dashboard"
|
|
4525
|
+
],
|
|
4349
4526
|
"operationId": "create_dashboard_layout",
|
|
4350
4527
|
"summary": "Create DashboardLayout",
|
|
4351
4528
|
"description": "### Create a dashboard layout on the dashboard with a specific id.",
|
|
@@ -4411,7 +4588,9 @@
|
|
|
4411
4588
|
},
|
|
4412
4589
|
"/data_actions": {
|
|
4413
4590
|
"post": {
|
|
4414
|
-
"tags": [
|
|
4591
|
+
"tags": [
|
|
4592
|
+
"DataAction"
|
|
4593
|
+
],
|
|
4415
4594
|
"operationId": "perform_data_action",
|
|
4416
4595
|
"summary": "Send a Data Action",
|
|
4417
4596
|
"description": "Perform a data action. The data action object can be obtained from query results, and used to perform an arbitrary action.",
|
|
@@ -4452,7 +4631,9 @@
|
|
|
4452
4631
|
},
|
|
4453
4632
|
"/data_actions/form": {
|
|
4454
4633
|
"post": {
|
|
4455
|
-
"tags": [
|
|
4634
|
+
"tags": [
|
|
4635
|
+
"DataAction"
|
|
4636
|
+
],
|
|
4456
4637
|
"operationId": "fetch_remote_data_action_form",
|
|
4457
4638
|
"summary": "Fetch Remote Data Action Form",
|
|
4458
4639
|
"description": "For some data actions, the remote server may supply a form requesting further user input. This endpoint takes a data action, asks the remote server to generate a form for it, and returns that form to you for presentation to the user.",
|
|
@@ -4502,7 +4683,9 @@
|
|
|
4502
4683
|
},
|
|
4503
4684
|
"/datagroups": {
|
|
4504
4685
|
"get": {
|
|
4505
|
-
"tags": [
|
|
4686
|
+
"tags": [
|
|
4687
|
+
"Datagroup"
|
|
4688
|
+
],
|
|
4506
4689
|
"operationId": "all_datagroups",
|
|
4507
4690
|
"summary": "Get All Datagroups",
|
|
4508
4691
|
"description": "### Get information about all datagroups.\n",
|
|
@@ -4535,7 +4718,9 @@
|
|
|
4535
4718
|
},
|
|
4536
4719
|
"/datagroups/{datagroup_id}": {
|
|
4537
4720
|
"get": {
|
|
4538
|
-
"tags": [
|
|
4721
|
+
"tags": [
|
|
4722
|
+
"Datagroup"
|
|
4723
|
+
],
|
|
4539
4724
|
"operationId": "datagroup",
|
|
4540
4725
|
"summary": "Get Datagroup",
|
|
4541
4726
|
"description": "### Get information about a datagroup.\n",
|
|
@@ -4572,7 +4757,9 @@
|
|
|
4572
4757
|
"x-looker-activity-type": "non_query"
|
|
4573
4758
|
},
|
|
4574
4759
|
"patch": {
|
|
4575
|
-
"tags": [
|
|
4760
|
+
"tags": [
|
|
4761
|
+
"Datagroup"
|
|
4762
|
+
],
|
|
4576
4763
|
"operationId": "update_datagroup",
|
|
4577
4764
|
"summary": "Update Datagroup",
|
|
4578
4765
|
"description": "### Update a datagroup using the specified params.\n",
|
|
@@ -4638,7 +4825,9 @@
|
|
|
4638
4825
|
},
|
|
4639
4826
|
"/connections": {
|
|
4640
4827
|
"get": {
|
|
4641
|
-
"tags": [
|
|
4828
|
+
"tags": [
|
|
4829
|
+
"Connection"
|
|
4830
|
+
],
|
|
4642
4831
|
"operationId": "all_connections",
|
|
4643
4832
|
"summary": "Get All Connections",
|
|
4644
4833
|
"description": "### Get information about all connections.\n",
|
|
@@ -4678,7 +4867,9 @@
|
|
|
4678
4867
|
"x-looker-activity-type": "non_query"
|
|
4679
4868
|
},
|
|
4680
4869
|
"post": {
|
|
4681
|
-
"tags": [
|
|
4870
|
+
"tags": [
|
|
4871
|
+
"Connection"
|
|
4872
|
+
],
|
|
4682
4873
|
"operationId": "create_connection",
|
|
4683
4874
|
"summary": "Create Connection",
|
|
4684
4875
|
"description": "### Create a connection using the specified configuration.\n",
|
|
@@ -4737,7 +4928,9 @@
|
|
|
4737
4928
|
},
|
|
4738
4929
|
"/connections/{connection_name}": {
|
|
4739
4930
|
"get": {
|
|
4740
|
-
"tags": [
|
|
4931
|
+
"tags": [
|
|
4932
|
+
"Connection"
|
|
4933
|
+
],
|
|
4741
4934
|
"operationId": "connection",
|
|
4742
4935
|
"summary": "Get Connection",
|
|
4743
4936
|
"description": "### Get information about a connection.\n",
|
|
@@ -4781,7 +4974,9 @@
|
|
|
4781
4974
|
"x-looker-activity-type": "non_query"
|
|
4782
4975
|
},
|
|
4783
4976
|
"patch": {
|
|
4784
|
-
"tags": [
|
|
4977
|
+
"tags": [
|
|
4978
|
+
"Connection"
|
|
4979
|
+
],
|
|
4785
4980
|
"operationId": "update_connection",
|
|
4786
4981
|
"summary": "Update Connection",
|
|
4787
4982
|
"description": "### Update a connection using the specified configuration.\n",
|
|
@@ -4839,7 +5034,9 @@
|
|
|
4839
5034
|
"x-looker-activity-type": "non_query"
|
|
4840
5035
|
},
|
|
4841
5036
|
"delete": {
|
|
4842
|
-
"tags": [
|
|
5037
|
+
"tags": [
|
|
5038
|
+
"Connection"
|
|
5039
|
+
],
|
|
4843
5040
|
"operationId": "delete_connection",
|
|
4844
5041
|
"summary": "Delete Connection",
|
|
4845
5042
|
"description": "### Delete a connection.\n",
|
|
@@ -4884,7 +5081,9 @@
|
|
|
4884
5081
|
},
|
|
4885
5082
|
"/connections/{connection_name}/connection_override/{override_context}": {
|
|
4886
5083
|
"delete": {
|
|
4887
|
-
"tags": [
|
|
5084
|
+
"tags": [
|
|
5085
|
+
"Connection"
|
|
5086
|
+
],
|
|
4888
5087
|
"operationId": "delete_connection_override",
|
|
4889
5088
|
"summary": "Delete Connection Override",
|
|
4890
5089
|
"description": "### Delete a connection override.\n",
|
|
@@ -4942,7 +5141,9 @@
|
|
|
4942
5141
|
},
|
|
4943
5142
|
"/connections/{connection_name}/test": {
|
|
4944
5143
|
"put": {
|
|
4945
|
-
"tags": [
|
|
5144
|
+
"tags": [
|
|
5145
|
+
"Connection"
|
|
5146
|
+
],
|
|
4946
5147
|
"operationId": "test_connection",
|
|
4947
5148
|
"summary": "Test Connection",
|
|
4948
5149
|
"description": "### Test an existing connection.\n\nNote that a connection's 'dialect' property has a 'connection_tests' property that lists the\nspecific types of tests that the connection supports.\n\nThis API is rate limited.\n\nUnsupported tests in the request will be ignored.\n",
|
|
@@ -5008,7 +5209,9 @@
|
|
|
5008
5209
|
},
|
|
5009
5210
|
"/connections/test": {
|
|
5010
5211
|
"put": {
|
|
5011
|
-
"tags": [
|
|
5212
|
+
"tags": [
|
|
5213
|
+
"Connection"
|
|
5214
|
+
],
|
|
5012
5215
|
"operationId": "test_connection_config",
|
|
5013
5216
|
"summary": "Test Connection Configuration",
|
|
5014
5217
|
"description": "### Test a connection configuration.\n\nNote that a connection's 'dialect' property has a 'connection_tests' property that lists the\nspecific types of tests that the connection supports.\n\nThis API is rate limited.\n\nUnsupported tests in the request will be ignored.\n",
|
|
@@ -5070,9 +5273,11 @@
|
|
|
5070
5273
|
},
|
|
5071
5274
|
"/derived_table/graph/model/{model}": {
|
|
5072
5275
|
"get": {
|
|
5073
|
-
"tags": [
|
|
5276
|
+
"tags": [
|
|
5277
|
+
"DerivedTable"
|
|
5278
|
+
],
|
|
5074
5279
|
"operationId": "graph_derived_tables_for_model",
|
|
5075
|
-
"summary": "Get Derived Table",
|
|
5280
|
+
"summary": "Get Derived Table graph for model",
|
|
5076
5281
|
"description": "### Discover information about derived tables\n",
|
|
5077
5282
|
"parameters": [
|
|
5078
5283
|
{
|
|
@@ -5121,9 +5326,66 @@
|
|
|
5121
5326
|
"x-looker-activity-type": "non_query"
|
|
5122
5327
|
}
|
|
5123
5328
|
},
|
|
5329
|
+
"/derived_table/graph/view/{view}": {
|
|
5330
|
+
"get": {
|
|
5331
|
+
"tags": [
|
|
5332
|
+
"DerivedTable"
|
|
5333
|
+
],
|
|
5334
|
+
"operationId": "graph_derived_tables_for_view",
|
|
5335
|
+
"summary": "Get subgraph of derived table and dependencies",
|
|
5336
|
+
"description": "### Get the subgraph representing this derived table and its dependencies.\n",
|
|
5337
|
+
"parameters": [
|
|
5338
|
+
{
|
|
5339
|
+
"name": "view",
|
|
5340
|
+
"in": "path",
|
|
5341
|
+
"description": "The derived table's view name.",
|
|
5342
|
+
"required": true,
|
|
5343
|
+
"type": "string"
|
|
5344
|
+
},
|
|
5345
|
+
{
|
|
5346
|
+
"name": "models",
|
|
5347
|
+
"in": "query",
|
|
5348
|
+
"description": "The models where this derived table is defined.",
|
|
5349
|
+
"required": false,
|
|
5350
|
+
"type": "string"
|
|
5351
|
+
},
|
|
5352
|
+
{
|
|
5353
|
+
"name": "workspace",
|
|
5354
|
+
"in": "query",
|
|
5355
|
+
"description": "The model directory to look in, either `dev` or `production`.",
|
|
5356
|
+
"required": false,
|
|
5357
|
+
"type": "string"
|
|
5358
|
+
}
|
|
5359
|
+
],
|
|
5360
|
+
"responses": {
|
|
5361
|
+
"200": {
|
|
5362
|
+
"description": "Graph of the derived table component, represented in the DOT language.",
|
|
5363
|
+
"schema": {
|
|
5364
|
+
"$ref": "#/definitions/DependencyGraph"
|
|
5365
|
+
}
|
|
5366
|
+
},
|
|
5367
|
+
"400": {
|
|
5368
|
+
"description": "Bad Request",
|
|
5369
|
+
"schema": {
|
|
5370
|
+
"$ref": "#/definitions/Error"
|
|
5371
|
+
}
|
|
5372
|
+
},
|
|
5373
|
+
"404": {
|
|
5374
|
+
"description": "Not Found",
|
|
5375
|
+
"schema": {
|
|
5376
|
+
"$ref": "#/definitions/Error"
|
|
5377
|
+
}
|
|
5378
|
+
}
|
|
5379
|
+
},
|
|
5380
|
+
"x-looker-status": "beta",
|
|
5381
|
+
"x-looker-activity-type": "non_query"
|
|
5382
|
+
}
|
|
5383
|
+
},
|
|
5124
5384
|
"/dialect_info": {
|
|
5125
5385
|
"get": {
|
|
5126
|
-
"tags": [
|
|
5386
|
+
"tags": [
|
|
5387
|
+
"Connection"
|
|
5388
|
+
],
|
|
5127
5389
|
"operationId": "all_dialect_infos",
|
|
5128
5390
|
"summary": "Get All Dialect Infos",
|
|
5129
5391
|
"description": "### Get information about all dialects.\n",
|
|
@@ -5165,7 +5427,9 @@
|
|
|
5165
5427
|
},
|
|
5166
5428
|
"/digest_emails_enabled": {
|
|
5167
5429
|
"get": {
|
|
5168
|
-
"tags": [
|
|
5430
|
+
"tags": [
|
|
5431
|
+
"Config"
|
|
5432
|
+
],
|
|
5169
5433
|
"operationId": "digest_emails_enabled",
|
|
5170
5434
|
"summary": "Get Digest_emails",
|
|
5171
5435
|
"description": "### Retrieve the value for whether or not digest emails is enabled\n",
|
|
@@ -5193,7 +5457,9 @@
|
|
|
5193
5457
|
"x-looker-activity-type": "non_query"
|
|
5194
5458
|
},
|
|
5195
5459
|
"patch": {
|
|
5196
|
-
"tags": [
|
|
5460
|
+
"tags": [
|
|
5461
|
+
"Config"
|
|
5462
|
+
],
|
|
5197
5463
|
"operationId": "update_digest_emails_enabled",
|
|
5198
5464
|
"summary": "Update Digest_emails",
|
|
5199
5465
|
"description": "### Update the setting for enabling/disabling digest emails\n",
|
|
@@ -5246,7 +5512,9 @@
|
|
|
5246
5512
|
},
|
|
5247
5513
|
"/digest_email_send": {
|
|
5248
5514
|
"post": {
|
|
5249
|
-
"tags": [
|
|
5515
|
+
"tags": [
|
|
5516
|
+
"Config"
|
|
5517
|
+
],
|
|
5250
5518
|
"operationId": "create_digest_email_send",
|
|
5251
5519
|
"summary": "Deliver digest email contents",
|
|
5252
5520
|
"description": "### Trigger the generation of digest email records and send them to Looker's internal system. This does not send\nany actual emails, it generates records containing content which may be of interest for users who have become inactive.\nEmails will be sent at a later time from Looker's internal system if the Digest Emails feature is enabled in settings.",
|
|
@@ -5283,7 +5551,9 @@
|
|
|
5283
5551
|
},
|
|
5284
5552
|
"/embed/sso_url": {
|
|
5285
5553
|
"post": {
|
|
5286
|
-
"tags": [
|
|
5554
|
+
"tags": [
|
|
5555
|
+
"Auth"
|
|
5556
|
+
],
|
|
5287
5557
|
"operationId": "create_sso_embed_url",
|
|
5288
5558
|
"summary": "Create SSO Embed Url",
|
|
5289
5559
|
"description": "### Create SSO Embed URL\n\nCreates an SSO embed URL and cryptographically signs it with an embed secret.\nThis signed URL can then be used to instantiate a Looker embed session in a PBL web application.\nDo not make any modifications to this URL - any change may invalidate the signature and\ncause the URL to fail to load a Looker embed session.\n\nA signed SSO embed URL can only be used once. After it has been used to request a page from the\nLooker server, the URL is invalid. Future requests using the same URL will fail. This is to prevent\n'replay attacks'.\n\nThe `target_url` property must be a complete URL of a Looker UI page - scheme, hostname, path and query params.\nTo load a dashboard with id 56 and with a filter of `Date=1 years`, the looker URL would look like `https:/myname.looker.com/dashboards/56?Date=1%20years`.\nThe best way to obtain this target_url is to navigate to the desired Looker page in your web browser,\ncopy the URL shown in the browser address bar and paste it into the `target_url` property as a quoted string value in this API request.\n\nPermissions for the embed user are defined by the groups in which the embed user is a member (group_ids property)\nand the lists of models and permissions assigned to the embed user.\nAt a minimum, you must provide values for either the group_ids property, or both the models and permissions properties.\nThese properties are additive; an embed user can be a member of certain groups AND be granted access to models and permissions.\n\nThe embed user's access is the union of permissions granted by the group_ids, models, and permissions properties.\n\nThis function does not strictly require all group_ids, user attribute names, or model names to exist at the moment the\nSSO embed url is created. Unknown group_id, user attribute names or model names will be passed through to the output URL.\nTo diagnose potential problems with an SSO embed URL, you can copy the signed URL into the Embed URI Validator text box in `<your looker instance>/admin/embed`.\n\nThe `secret_id` parameter is optional. If specified, its value must be the id of an active secret defined in the Looker instance.\nif not specified, the URL will be signed using the newest active secret defined in the Looker instance.\n\n#### Security Note\nProtect this signed URL as you would an access token or password credentials - do not write\nit to disk, do not pass it to a third party, and only pass it through a secure HTTPS\nencrypted transport.\n",
|
|
@@ -5342,7 +5612,9 @@
|
|
|
5342
5612
|
},
|
|
5343
5613
|
"/projects/{project_id}/git_branches": {
|
|
5344
5614
|
"get": {
|
|
5345
|
-
"tags": [
|
|
5615
|
+
"tags": [
|
|
5616
|
+
"Project"
|
|
5617
|
+
],
|
|
5346
5618
|
"operationId": "all_git_branches",
|
|
5347
5619
|
"summary": "Get All Git Branches",
|
|
5348
5620
|
"description": "### Get All Git Branches\n\nReturns a list of git branches in the project repository\n",
|
|
@@ -5384,7 +5656,9 @@
|
|
|
5384
5656
|
},
|
|
5385
5657
|
"/projects/{project_id}/git_branch": {
|
|
5386
5658
|
"get": {
|
|
5387
|
-
"tags": [
|
|
5659
|
+
"tags": [
|
|
5660
|
+
"Project"
|
|
5661
|
+
],
|
|
5388
5662
|
"operationId": "git_branch",
|
|
5389
5663
|
"summary": "Get Active Git Branch",
|
|
5390
5664
|
"description": "### Get the Current Git Branch\n\nReturns the git branch currently checked out in the given project repository\n",
|
|
@@ -5421,7 +5695,9 @@
|
|
|
5421
5695
|
"x-looker-activity-type": "non_query"
|
|
5422
5696
|
},
|
|
5423
5697
|
"post": {
|
|
5424
|
-
"tags": [
|
|
5698
|
+
"tags": [
|
|
5699
|
+
"Project"
|
|
5700
|
+
],
|
|
5425
5701
|
"operationId": "create_git_branch",
|
|
5426
5702
|
"summary": "Checkout New Git Branch",
|
|
5427
5703
|
"description": "### Create and Checkout a Git Branch\n\nCreates and checks out a new branch in the given project repository\nOnly allowed in development mode\n - Call `update_session` to select the 'dev' workspace.\n\nOptionally specify a branch name, tag name or commit SHA as the start point in the ref field.\n If no ref is specified, HEAD of the current branch will be used as the start point for the new branch.\n\n",
|
|
@@ -5485,7 +5761,9 @@
|
|
|
5485
5761
|
"x-looker-activity-type": "non_query"
|
|
5486
5762
|
},
|
|
5487
5763
|
"put": {
|
|
5488
|
-
"tags": [
|
|
5764
|
+
"tags": [
|
|
5765
|
+
"Project"
|
|
5766
|
+
],
|
|
5489
5767
|
"operationId": "update_git_branch",
|
|
5490
5768
|
"summary": "Update Project Git Branch",
|
|
5491
5769
|
"description": "### Checkout and/or reset --hard an existing Git Branch\n\nOnly allowed in development mode\n - Call `update_session` to select the 'dev' workspace.\n\nCheckout an existing branch if name field is different from the name of the currently checked out branch.\n\nOptionally specify a branch name, tag name or commit SHA to which the branch should be reset.\n **DANGER** hard reset will be force pushed to the remote. Unsaved changes and commits may be permanently lost.\n\n",
|
|
@@ -5545,7 +5823,9 @@
|
|
|
5545
5823
|
},
|
|
5546
5824
|
"/projects/{project_id}/git_branch/{branch_name}": {
|
|
5547
5825
|
"get": {
|
|
5548
|
-
"tags": [
|
|
5826
|
+
"tags": [
|
|
5827
|
+
"Project"
|
|
5828
|
+
],
|
|
5549
5829
|
"operationId": "find_git_branch",
|
|
5550
5830
|
"summary": "Find a Git Branch",
|
|
5551
5831
|
"description": "### Get the specified Git Branch\n\nReturns the git branch specified in branch_name path param if it exists in the given project repository\n",
|
|
@@ -5589,7 +5869,9 @@
|
|
|
5589
5869
|
"x-looker-activity-type": "non_query"
|
|
5590
5870
|
},
|
|
5591
5871
|
"delete": {
|
|
5592
|
-
"tags": [
|
|
5872
|
+
"tags": [
|
|
5873
|
+
"Project"
|
|
5874
|
+
],
|
|
5593
5875
|
"operationId": "delete_git_branch",
|
|
5594
5876
|
"summary": "Delete a Git Branch",
|
|
5595
5877
|
"description": "### Delete the specified Git Branch\n\nDelete git branch specified in branch_name path param from local and remote of specified project repository\n",
|
|
@@ -5641,7 +5923,9 @@
|
|
|
5641
5923
|
},
|
|
5642
5924
|
"/groups": {
|
|
5643
5925
|
"get": {
|
|
5644
|
-
"tags": [
|
|
5926
|
+
"tags": [
|
|
5927
|
+
"Group"
|
|
5928
|
+
],
|
|
5645
5929
|
"operationId": "all_groups",
|
|
5646
5930
|
"summary": "Get All Groups",
|
|
5647
5931
|
"description": "### Get information about all groups.\n",
|
|
@@ -5731,7 +6015,9 @@
|
|
|
5731
6015
|
"x-looker-activity-type": "non_query"
|
|
5732
6016
|
},
|
|
5733
6017
|
"post": {
|
|
5734
|
-
"tags": [
|
|
6018
|
+
"tags": [
|
|
6019
|
+
"Group"
|
|
6020
|
+
],
|
|
5735
6021
|
"operationId": "create_group",
|
|
5736
6022
|
"summary": "Create Group",
|
|
5737
6023
|
"description": "### Creates a new group (admin only).\n",
|
|
@@ -5797,7 +6083,9 @@
|
|
|
5797
6083
|
},
|
|
5798
6084
|
"/groups/search": {
|
|
5799
6085
|
"get": {
|
|
5800
|
-
"tags": [
|
|
6086
|
+
"tags": [
|
|
6087
|
+
"Group"
|
|
6088
|
+
],
|
|
5801
6089
|
"operationId": "search_groups",
|
|
5802
6090
|
"summary": "Search Groups",
|
|
5803
6091
|
"description": "### Search groups\n\nReturns all group records that match the given search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -5905,7 +6193,9 @@
|
|
|
5905
6193
|
},
|
|
5906
6194
|
"/groups/{group_id}": {
|
|
5907
6195
|
"get": {
|
|
5908
|
-
"tags": [
|
|
6196
|
+
"tags": [
|
|
6197
|
+
"Group"
|
|
6198
|
+
],
|
|
5909
6199
|
"operationId": "group",
|
|
5910
6200
|
"summary": "Get Group",
|
|
5911
6201
|
"description": "### Get information about a group.\n",
|
|
@@ -5950,7 +6240,9 @@
|
|
|
5950
6240
|
"x-looker-activity-type": "non_query"
|
|
5951
6241
|
},
|
|
5952
6242
|
"patch": {
|
|
5953
|
-
"tags": [
|
|
6243
|
+
"tags": [
|
|
6244
|
+
"Group"
|
|
6245
|
+
],
|
|
5954
6246
|
"operationId": "update_group",
|
|
5955
6247
|
"summary": "Update Group",
|
|
5956
6248
|
"description": "### Updates the a group (admin only).",
|
|
@@ -6016,7 +6308,9 @@
|
|
|
6016
6308
|
"x-looker-activity-type": "non_query"
|
|
6017
6309
|
},
|
|
6018
6310
|
"delete": {
|
|
6019
|
-
"tags": [
|
|
6311
|
+
"tags": [
|
|
6312
|
+
"Group"
|
|
6313
|
+
],
|
|
6020
6314
|
"operationId": "delete_group",
|
|
6021
6315
|
"summary": "Delete Group",
|
|
6022
6316
|
"description": "### Deletes a group (admin only).\n",
|
|
@@ -6068,7 +6362,9 @@
|
|
|
6068
6362
|
},
|
|
6069
6363
|
"/groups/{group_id}/groups": {
|
|
6070
6364
|
"get": {
|
|
6071
|
-
"tags": [
|
|
6365
|
+
"tags": [
|
|
6366
|
+
"Group"
|
|
6367
|
+
],
|
|
6072
6368
|
"operationId": "all_group_groups",
|
|
6073
6369
|
"summary": "Get All Groups in Group",
|
|
6074
6370
|
"description": "### Get information about all the groups in a group\n",
|
|
@@ -6116,7 +6412,9 @@
|
|
|
6116
6412
|
"x-looker-activity-type": "non_query"
|
|
6117
6413
|
},
|
|
6118
6414
|
"post": {
|
|
6119
|
-
"tags": [
|
|
6415
|
+
"tags": [
|
|
6416
|
+
"Group"
|
|
6417
|
+
],
|
|
6120
6418
|
"operationId": "add_group_group",
|
|
6121
6419
|
"summary": "Add a Group to Group",
|
|
6122
6420
|
"description": "### Adds a new group to a group.\n",
|
|
@@ -6171,7 +6469,9 @@
|
|
|
6171
6469
|
},
|
|
6172
6470
|
"/groups/{group_id}/users": {
|
|
6173
6471
|
"get": {
|
|
6174
|
-
"tags": [
|
|
6472
|
+
"tags": [
|
|
6473
|
+
"Group"
|
|
6474
|
+
],
|
|
6175
6475
|
"operationId": "all_group_users",
|
|
6176
6476
|
"summary": "Get All Users in Group",
|
|
6177
6477
|
"description": "### Get information about all the users directly included in a group.\n",
|
|
@@ -6242,7 +6542,9 @@
|
|
|
6242
6542
|
"x-looker-activity-type": "non_query"
|
|
6243
6543
|
},
|
|
6244
6544
|
"post": {
|
|
6245
|
-
"tags": [
|
|
6545
|
+
"tags": [
|
|
6546
|
+
"Group"
|
|
6547
|
+
],
|
|
6246
6548
|
"operationId": "add_group_user",
|
|
6247
6549
|
"summary": "Add a User to Group",
|
|
6248
6550
|
"description": "### Adds a new user to a group.\n",
|
|
@@ -6297,7 +6599,9 @@
|
|
|
6297
6599
|
},
|
|
6298
6600
|
"/groups/{group_id}/users/{user_id}": {
|
|
6299
6601
|
"delete": {
|
|
6300
|
-
"tags": [
|
|
6602
|
+
"tags": [
|
|
6603
|
+
"Group"
|
|
6604
|
+
],
|
|
6301
6605
|
"operationId": "delete_group_user",
|
|
6302
6606
|
"summary": "Remove a User from Group",
|
|
6303
6607
|
"description": "### Removes a user from a group.\n",
|
|
@@ -6348,7 +6652,9 @@
|
|
|
6348
6652
|
},
|
|
6349
6653
|
"/groups/{group_id}/groups/{deleting_group_id}": {
|
|
6350
6654
|
"delete": {
|
|
6351
|
-
"tags": [
|
|
6655
|
+
"tags": [
|
|
6656
|
+
"Group"
|
|
6657
|
+
],
|
|
6352
6658
|
"operationId": "delete_group_from_group",
|
|
6353
6659
|
"summary": "Deletes a Group from Group",
|
|
6354
6660
|
"description": "### Removes a group from a group.\n",
|
|
@@ -6399,7 +6705,9 @@
|
|
|
6399
6705
|
},
|
|
6400
6706
|
"/groups/{group_id}/attribute_values/{user_attribute_id}": {
|
|
6401
6707
|
"patch": {
|
|
6402
|
-
"tags": [
|
|
6708
|
+
"tags": [
|
|
6709
|
+
"Group"
|
|
6710
|
+
],
|
|
6403
6711
|
"operationId": "update_user_attribute_group_value",
|
|
6404
6712
|
"summary": "Set User Attribute Group Value",
|
|
6405
6713
|
"description": "### Set the value of a user attribute for a group.\n\nFor information about how user attribute values are calculated, see [Set User Attribute Group Values](#!/UserAttribute/set_user_attribute_group_values).\n",
|
|
@@ -6460,7 +6768,9 @@
|
|
|
6460
6768
|
"x-looker-activity-type": "non_query"
|
|
6461
6769
|
},
|
|
6462
6770
|
"delete": {
|
|
6463
|
-
"tags": [
|
|
6771
|
+
"tags": [
|
|
6772
|
+
"Group"
|
|
6773
|
+
],
|
|
6464
6774
|
"operationId": "delete_user_attribute_group_value",
|
|
6465
6775
|
"summary": "Delete User Attribute Group Value",
|
|
6466
6776
|
"description": "### Remove a user attribute value from a group.\n",
|
|
@@ -6505,7 +6815,9 @@
|
|
|
6505
6815
|
},
|
|
6506
6816
|
"/homepages": {
|
|
6507
6817
|
"get": {
|
|
6508
|
-
"tags": [
|
|
6818
|
+
"tags": [
|
|
6819
|
+
"Homepage"
|
|
6820
|
+
],
|
|
6509
6821
|
"operationId": "all_homepages",
|
|
6510
6822
|
"summary": "Get All Homepages",
|
|
6511
6823
|
"description": "### Get information about all homepages.\n",
|
|
@@ -6546,7 +6858,9 @@
|
|
|
6546
6858
|
"x-looker-activity-type": "non_query"
|
|
6547
6859
|
},
|
|
6548
6860
|
"post": {
|
|
6549
|
-
"tags": [
|
|
6861
|
+
"tags": [
|
|
6862
|
+
"Homepage"
|
|
6863
|
+
],
|
|
6550
6864
|
"operationId": "create_homepage",
|
|
6551
6865
|
"summary": "Create Homepage",
|
|
6552
6866
|
"description": "### Create a new homepage.\n",
|
|
@@ -6613,7 +6927,9 @@
|
|
|
6613
6927
|
},
|
|
6614
6928
|
"/homepages/search": {
|
|
6615
6929
|
"get": {
|
|
6616
|
-
"tags": [
|
|
6930
|
+
"tags": [
|
|
6931
|
+
"Homepage"
|
|
6932
|
+
],
|
|
6617
6933
|
"operationId": "search_homepages",
|
|
6618
6934
|
"summary": "Search Homepages",
|
|
6619
6935
|
"description": "### Search Homepages\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -6744,7 +7060,9 @@
|
|
|
6744
7060
|
},
|
|
6745
7061
|
"/homepages/{homepage_id}": {
|
|
6746
7062
|
"get": {
|
|
6747
|
-
"tags": [
|
|
7063
|
+
"tags": [
|
|
7064
|
+
"Homepage"
|
|
7065
|
+
],
|
|
6748
7066
|
"operationId": "homepage",
|
|
6749
7067
|
"summary": "Get Homepage",
|
|
6750
7068
|
"description": "### Get information about a homepage.\n",
|
|
@@ -6790,7 +7108,9 @@
|
|
|
6790
7108
|
"x-looker-activity-type": "non_query"
|
|
6791
7109
|
},
|
|
6792
7110
|
"patch": {
|
|
6793
|
-
"tags": [
|
|
7111
|
+
"tags": [
|
|
7112
|
+
"Homepage"
|
|
7113
|
+
],
|
|
6794
7114
|
"operationId": "update_homepage",
|
|
6795
7115
|
"summary": "Update Homepage",
|
|
6796
7116
|
"description": "### Update a homepage definition.\n",
|
|
@@ -6857,7 +7177,9 @@
|
|
|
6857
7177
|
"x-looker-activity-type": "non_query"
|
|
6858
7178
|
},
|
|
6859
7179
|
"delete": {
|
|
6860
|
-
"tags": [
|
|
7180
|
+
"tags": [
|
|
7181
|
+
"Homepage"
|
|
7182
|
+
],
|
|
6861
7183
|
"operationId": "delete_homepage",
|
|
6862
7184
|
"summary": "Delete Homepage",
|
|
6863
7185
|
"description": "### Delete a homepage.\n",
|
|
@@ -6904,7 +7226,9 @@
|
|
|
6904
7226
|
},
|
|
6905
7227
|
"/homepage_items": {
|
|
6906
7228
|
"get": {
|
|
6907
|
-
"tags": [
|
|
7229
|
+
"tags": [
|
|
7230
|
+
"Homepage"
|
|
7231
|
+
],
|
|
6908
7232
|
"operationId": "all_homepage_items",
|
|
6909
7233
|
"summary": "Get All Homepage Items",
|
|
6910
7234
|
"description": "### Get information about all homepage items.\n",
|
|
@@ -6959,7 +7283,9 @@
|
|
|
6959
7283
|
"x-looker-activity-type": "non_query"
|
|
6960
7284
|
},
|
|
6961
7285
|
"post": {
|
|
6962
|
-
"tags": [
|
|
7286
|
+
"tags": [
|
|
7287
|
+
"Homepage"
|
|
7288
|
+
],
|
|
6963
7289
|
"operationId": "create_homepage_item",
|
|
6964
7290
|
"summary": "Create Homepage Item",
|
|
6965
7291
|
"description": "### Create a new homepage item.\n",
|
|
@@ -7026,7 +7352,9 @@
|
|
|
7026
7352
|
},
|
|
7027
7353
|
"/homepage_items/{homepage_item_id}": {
|
|
7028
7354
|
"get": {
|
|
7029
|
-
"tags": [
|
|
7355
|
+
"tags": [
|
|
7356
|
+
"Homepage"
|
|
7357
|
+
],
|
|
7030
7358
|
"operationId": "homepage_item",
|
|
7031
7359
|
"summary": "Get Homepage Item",
|
|
7032
7360
|
"description": "### Get information about a homepage item.\n",
|
|
@@ -7072,7 +7400,9 @@
|
|
|
7072
7400
|
"x-looker-activity-type": "non_query"
|
|
7073
7401
|
},
|
|
7074
7402
|
"patch": {
|
|
7075
|
-
"tags": [
|
|
7403
|
+
"tags": [
|
|
7404
|
+
"Homepage"
|
|
7405
|
+
],
|
|
7076
7406
|
"operationId": "update_homepage_item",
|
|
7077
7407
|
"summary": "Update Homepage Item",
|
|
7078
7408
|
"description": "### Update a homepage item definition.\n",
|
|
@@ -7139,7 +7469,9 @@
|
|
|
7139
7469
|
"x-looker-activity-type": "non_query"
|
|
7140
7470
|
},
|
|
7141
7471
|
"delete": {
|
|
7142
|
-
"tags": [
|
|
7472
|
+
"tags": [
|
|
7473
|
+
"Homepage"
|
|
7474
|
+
],
|
|
7143
7475
|
"operationId": "delete_homepage_item",
|
|
7144
7476
|
"summary": "Delete Homepage Item",
|
|
7145
7477
|
"description": "### Delete a homepage item.\n",
|
|
@@ -7186,7 +7518,9 @@
|
|
|
7186
7518
|
},
|
|
7187
7519
|
"/homepage_sections": {
|
|
7188
7520
|
"get": {
|
|
7189
|
-
"tags": [
|
|
7521
|
+
"tags": [
|
|
7522
|
+
"Homepage"
|
|
7523
|
+
],
|
|
7190
7524
|
"operationId": "all_homepage_sections",
|
|
7191
7525
|
"summary": "Get All Homepage sections",
|
|
7192
7526
|
"description": "### Get information about all homepage sections.\n",
|
|
@@ -7234,7 +7568,9 @@
|
|
|
7234
7568
|
"x-looker-activity-type": "non_query"
|
|
7235
7569
|
},
|
|
7236
7570
|
"post": {
|
|
7237
|
-
"tags": [
|
|
7571
|
+
"tags": [
|
|
7572
|
+
"Homepage"
|
|
7573
|
+
],
|
|
7238
7574
|
"operationId": "create_homepage_section",
|
|
7239
7575
|
"summary": "Create Homepage section",
|
|
7240
7576
|
"description": "### Create a new homepage section.\n",
|
|
@@ -7301,7 +7637,9 @@
|
|
|
7301
7637
|
},
|
|
7302
7638
|
"/homepage_sections/{homepage_section_id}": {
|
|
7303
7639
|
"get": {
|
|
7304
|
-
"tags": [
|
|
7640
|
+
"tags": [
|
|
7641
|
+
"Homepage"
|
|
7642
|
+
],
|
|
7305
7643
|
"operationId": "homepage_section",
|
|
7306
7644
|
"summary": "Get Homepage section",
|
|
7307
7645
|
"description": "### Get information about a homepage section.\n",
|
|
@@ -7347,7 +7685,9 @@
|
|
|
7347
7685
|
"x-looker-activity-type": "non_query"
|
|
7348
7686
|
},
|
|
7349
7687
|
"patch": {
|
|
7350
|
-
"tags": [
|
|
7688
|
+
"tags": [
|
|
7689
|
+
"Homepage"
|
|
7690
|
+
],
|
|
7351
7691
|
"operationId": "update_homepage_section",
|
|
7352
7692
|
"summary": "Update Homepage section",
|
|
7353
7693
|
"description": "### Update a homepage section definition.\n",
|
|
@@ -7414,7 +7754,9 @@
|
|
|
7414
7754
|
"x-looker-activity-type": "non_query"
|
|
7415
7755
|
},
|
|
7416
7756
|
"delete": {
|
|
7417
|
-
"tags": [
|
|
7757
|
+
"tags": [
|
|
7758
|
+
"Homepage"
|
|
7759
|
+
],
|
|
7418
7760
|
"operationId": "delete_homepage_section",
|
|
7419
7761
|
"summary": "Delete Homepage section",
|
|
7420
7762
|
"description": "### Delete a homepage section.\n",
|
|
@@ -7461,7 +7803,9 @@
|
|
|
7461
7803
|
},
|
|
7462
7804
|
"/primary_homepage_sections": {
|
|
7463
7805
|
"get": {
|
|
7464
|
-
"tags": [
|
|
7806
|
+
"tags": [
|
|
7807
|
+
"Homepage"
|
|
7808
|
+
],
|
|
7465
7809
|
"operationId": "all_primary_homepage_sections",
|
|
7466
7810
|
"summary": "Get All Primary homepage sections",
|
|
7467
7811
|
"description": "### Get information about the primary homepage's sections.\n",
|
|
@@ -7503,7 +7847,9 @@
|
|
|
7503
7847
|
},
|
|
7504
7848
|
"/integration_hubs": {
|
|
7505
7849
|
"get": {
|
|
7506
|
-
"tags": [
|
|
7850
|
+
"tags": [
|
|
7851
|
+
"Integration"
|
|
7852
|
+
],
|
|
7507
7853
|
"operationId": "all_integration_hubs",
|
|
7508
7854
|
"summary": "Get All Integration Hubs",
|
|
7509
7855
|
"description": "### Get information about all Integration Hubs.\n",
|
|
@@ -7543,7 +7889,9 @@
|
|
|
7543
7889
|
"x-looker-activity-type": "non_query"
|
|
7544
7890
|
},
|
|
7545
7891
|
"post": {
|
|
7546
|
-
"tags": [
|
|
7892
|
+
"tags": [
|
|
7893
|
+
"Integration"
|
|
7894
|
+
],
|
|
7547
7895
|
"operationId": "create_integration_hub",
|
|
7548
7896
|
"summary": "Create Integration Hub",
|
|
7549
7897
|
"description": "### Create a new Integration Hub.\n\nThis API is rate limited to prevent it from being used for SSRF attacks\n",
|
|
@@ -7610,7 +7958,9 @@
|
|
|
7610
7958
|
},
|
|
7611
7959
|
"/integration_hubs/{integration_hub_id}": {
|
|
7612
7960
|
"get": {
|
|
7613
|
-
"tags": [
|
|
7961
|
+
"tags": [
|
|
7962
|
+
"Integration"
|
|
7963
|
+
],
|
|
7614
7964
|
"operationId": "integration_hub",
|
|
7615
7965
|
"summary": "Get Integration Hub",
|
|
7616
7966
|
"description": "### Get information about a Integration Hub.\n",
|
|
@@ -7655,7 +8005,9 @@
|
|
|
7655
8005
|
"x-looker-activity-type": "non_query"
|
|
7656
8006
|
},
|
|
7657
8007
|
"patch": {
|
|
7658
|
-
"tags": [
|
|
8008
|
+
"tags": [
|
|
8009
|
+
"Integration"
|
|
8010
|
+
],
|
|
7659
8011
|
"operationId": "update_integration_hub",
|
|
7660
8012
|
"summary": "Update Integration Hub",
|
|
7661
8013
|
"description": "### Update a Integration Hub definition.\n\nThis API is rate limited to prevent it from being used for SSRF attacks\n",
|
|
@@ -7722,7 +8074,9 @@
|
|
|
7722
8074
|
"x-looker-rate-limited": true
|
|
7723
8075
|
},
|
|
7724
8076
|
"delete": {
|
|
7725
|
-
"tags": [
|
|
8077
|
+
"tags": [
|
|
8078
|
+
"Integration"
|
|
8079
|
+
],
|
|
7726
8080
|
"operationId": "delete_integration_hub",
|
|
7727
8081
|
"summary": "Delete Integration Hub",
|
|
7728
8082
|
"description": "### Delete a Integration Hub.\n",
|
|
@@ -7768,7 +8122,9 @@
|
|
|
7768
8122
|
},
|
|
7769
8123
|
"/integration_hubs/{integration_hub_id}/accept_legal_agreement": {
|
|
7770
8124
|
"post": {
|
|
7771
|
-
"tags": [
|
|
8125
|
+
"tags": [
|
|
8126
|
+
"Integration"
|
|
8127
|
+
],
|
|
7772
8128
|
"operationId": "accept_integration_hub_legal_agreement",
|
|
7773
8129
|
"summary": "Accept Integration Hub Legal Agreement",
|
|
7774
8130
|
"description": "Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.",
|
|
@@ -7814,7 +8170,9 @@
|
|
|
7814
8170
|
},
|
|
7815
8171
|
"/integrations": {
|
|
7816
8172
|
"get": {
|
|
7817
|
-
"tags": [
|
|
8173
|
+
"tags": [
|
|
8174
|
+
"Integration"
|
|
8175
|
+
],
|
|
7818
8176
|
"operationId": "all_integrations",
|
|
7819
8177
|
"summary": "Get All Integrations",
|
|
7820
8178
|
"description": "### Get information about all Integrations.\n",
|
|
@@ -7863,7 +8221,9 @@
|
|
|
7863
8221
|
},
|
|
7864
8222
|
"/integrations/{integration_id}": {
|
|
7865
8223
|
"get": {
|
|
7866
|
-
"tags": [
|
|
8224
|
+
"tags": [
|
|
8225
|
+
"Integration"
|
|
8226
|
+
],
|
|
7867
8227
|
"operationId": "integration",
|
|
7868
8228
|
"summary": "Get Integration",
|
|
7869
8229
|
"description": "### Get information about a Integration.\n",
|
|
@@ -7907,7 +8267,9 @@
|
|
|
7907
8267
|
"x-looker-activity-type": "non_query"
|
|
7908
8268
|
},
|
|
7909
8269
|
"patch": {
|
|
7910
|
-
"tags": [
|
|
8270
|
+
"tags": [
|
|
8271
|
+
"Integration"
|
|
8272
|
+
],
|
|
7911
8273
|
"operationId": "update_integration",
|
|
7912
8274
|
"summary": "Update Integration",
|
|
7913
8275
|
"description": "### Update parameters on a Integration.\n",
|
|
@@ -7974,7 +8336,9 @@
|
|
|
7974
8336
|
},
|
|
7975
8337
|
"/integrations/{integration_id}/form": {
|
|
7976
8338
|
"post": {
|
|
7977
|
-
"tags": [
|
|
8339
|
+
"tags": [
|
|
8340
|
+
"Integration"
|
|
8341
|
+
],
|
|
7978
8342
|
"operationId": "fetch_integration_form",
|
|
7979
8343
|
"summary": "Fetch Remote Integration Form",
|
|
7980
8344
|
"description": "Returns the Integration form for presentation to the user.",
|
|
@@ -8031,7 +8395,9 @@
|
|
|
8031
8395
|
},
|
|
8032
8396
|
"/integrations/{integration_id}/test": {
|
|
8033
8397
|
"post": {
|
|
8034
|
-
"tags": [
|
|
8398
|
+
"tags": [
|
|
8399
|
+
"Integration"
|
|
8400
|
+
],
|
|
8035
8401
|
"operationId": "test_integration",
|
|
8036
8402
|
"summary": "Test integration",
|
|
8037
8403
|
"description": "Tests the integration to make sure all the settings are working.",
|
|
@@ -8076,7 +8442,9 @@
|
|
|
8076
8442
|
},
|
|
8077
8443
|
"/internal_help_resources_content": {
|
|
8078
8444
|
"get": {
|
|
8079
|
-
"tags": [
|
|
8445
|
+
"tags": [
|
|
8446
|
+
"Config"
|
|
8447
|
+
],
|
|
8080
8448
|
"operationId": "internal_help_resources_content",
|
|
8081
8449
|
"summary": "Get Internal Help Resources Content",
|
|
8082
8450
|
"description": "### Set the menu item name and content for internal help resources\n",
|
|
@@ -8104,7 +8472,9 @@
|
|
|
8104
8472
|
"x-looker-activity-type": "non_query"
|
|
8105
8473
|
},
|
|
8106
8474
|
"patch": {
|
|
8107
|
-
"tags": [
|
|
8475
|
+
"tags": [
|
|
8476
|
+
"Config"
|
|
8477
|
+
],
|
|
8108
8478
|
"operationId": "update_internal_help_resources_content",
|
|
8109
8479
|
"summary": "Update internal help resources content",
|
|
8110
8480
|
"description": "Update internal help resources content\n",
|
|
@@ -8157,7 +8527,9 @@
|
|
|
8157
8527
|
},
|
|
8158
8528
|
"/internal_help_resources_enabled": {
|
|
8159
8529
|
"get": {
|
|
8160
|
-
"tags": [
|
|
8530
|
+
"tags": [
|
|
8531
|
+
"Config"
|
|
8532
|
+
],
|
|
8161
8533
|
"operationId": "internal_help_resources",
|
|
8162
8534
|
"summary": "Get Internal Help Resources",
|
|
8163
8535
|
"description": "### Get and set the options for internal help resources\n",
|
|
@@ -8187,7 +8559,9 @@
|
|
|
8187
8559
|
},
|
|
8188
8560
|
"/internal_help_resources": {
|
|
8189
8561
|
"patch": {
|
|
8190
|
-
"tags": [
|
|
8562
|
+
"tags": [
|
|
8563
|
+
"Config"
|
|
8564
|
+
],
|
|
8191
8565
|
"operationId": "update_internal_help_resources",
|
|
8192
8566
|
"summary": "Update internal help resources configuration",
|
|
8193
8567
|
"description": "Update internal help resources settings\n",
|
|
@@ -8240,7 +8614,9 @@
|
|
|
8240
8614
|
},
|
|
8241
8615
|
"/ldap_config": {
|
|
8242
8616
|
"get": {
|
|
8243
|
-
"tags": [
|
|
8617
|
+
"tags": [
|
|
8618
|
+
"Auth"
|
|
8619
|
+
],
|
|
8244
8620
|
"operationId": "ldap_config",
|
|
8245
8621
|
"summary": "Get LDAP Configuration",
|
|
8246
8622
|
"description": "### Get the LDAP configuration.\n\nLooker can be optionally configured to authenticate users against an Active Directory or other LDAP directory server.\nLDAP setup requires coordination with an administrator of that directory server.\n\nOnly Looker administrators can read and update the LDAP configuration.\n\nConfiguring LDAP impacts authentication for all users. This configuration should be done carefully.\n\nLooker maintains a single LDAP configuration. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct).\n\nLDAP is enabled or disabled for Looker using the **enabled** field.\n\nLooker will never return an **auth_password** field. That value can be set, but never retrieved.\n\nSee the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.\n",
|
|
@@ -8262,7 +8638,9 @@
|
|
|
8262
8638
|
"x-looker-activity-type": "non_query"
|
|
8263
8639
|
},
|
|
8264
8640
|
"patch": {
|
|
8265
|
-
"tags": [
|
|
8641
|
+
"tags": [
|
|
8642
|
+
"Auth"
|
|
8643
|
+
],
|
|
8266
8644
|
"operationId": "update_ldap_config",
|
|
8267
8645
|
"summary": "Update LDAP Configuration",
|
|
8268
8646
|
"description": "### Update the LDAP configuration.\n\nConfiguring LDAP impacts authentication for all users. This configuration should be done carefully.\n\nOnly Looker administrators can read and update the LDAP configuration.\n\nLDAP is enabled or disabled for Looker using the **enabled** field.\n\nIt is **highly** recommended that any LDAP setting changes be tested using the APIs below before being set globally.\n\nSee the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.\n",
|
|
@@ -8309,7 +8687,9 @@
|
|
|
8309
8687
|
},
|
|
8310
8688
|
"/ldap_config/test_connection": {
|
|
8311
8689
|
"put": {
|
|
8312
|
-
"tags": [
|
|
8690
|
+
"tags": [
|
|
8691
|
+
"Auth"
|
|
8692
|
+
],
|
|
8313
8693
|
"operationId": "test_ldap_config_connection",
|
|
8314
8694
|
"summary": "Test LDAP Connection",
|
|
8315
8695
|
"description": "### Test the connection settings for an LDAP configuration.\n\nThis tests that the connection is possible given a connection_host and connection_port.\n\n**connection_host** and **connection_port** are required. **connection_tls** is optional.\n\nExample:\n```json\n{\n \"connection_host\": \"ldap.example.com\",\n \"connection_port\": \"636\",\n \"connection_tls\": true\n}\n```\n\nNo authentication to the LDAP server is attempted.\n\nThe active LDAP settings are not modified.\n",
|
|
@@ -8356,7 +8736,9 @@
|
|
|
8356
8736
|
},
|
|
8357
8737
|
"/ldap_config/test_auth": {
|
|
8358
8738
|
"put": {
|
|
8359
|
-
"tags": [
|
|
8739
|
+
"tags": [
|
|
8740
|
+
"Auth"
|
|
8741
|
+
],
|
|
8360
8742
|
"operationId": "test_ldap_config_auth",
|
|
8361
8743
|
"summary": "Test LDAP Auth",
|
|
8362
8744
|
"description": "### Test the connection authentication settings for an LDAP configuration.\n\nThis tests that the connection is possible and that a 'server' account to be used by Looker can authenticate to the LDAP server given connection and authentication information.\n\n**connection_host**, **connection_port**, and **auth_username**, are required. **connection_tls** and **auth_password** are optional.\n\nExample:\n```json\n{\n \"connection_host\": \"ldap.example.com\",\n \"connection_port\": \"636\",\n \"connection_tls\": true,\n \"auth_username\": \"cn=looker,dc=example,dc=com\",\n \"auth_password\": \"secret\"\n}\n```\n\nLooker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test.\n\nThe active LDAP settings are not modified.\n\n",
|
|
@@ -8403,7 +8785,9 @@
|
|
|
8403
8785
|
},
|
|
8404
8786
|
"/ldap_config/test_user_info": {
|
|
8405
8787
|
"put": {
|
|
8406
|
-
"tags": [
|
|
8788
|
+
"tags": [
|
|
8789
|
+
"Auth"
|
|
8790
|
+
],
|
|
8407
8791
|
"operationId": "test_ldap_config_user_info",
|
|
8408
8792
|
"summary": "Test LDAP User Info",
|
|
8409
8793
|
"description": "### Test the user authentication settings for an LDAP configuration without authenticating the user.\n\nThis test will let you easily test the mapping for user properties and roles for any user without needing to authenticate as that user.\n\nThis test accepts a full LDAP configuration along with a username and attempts to find the full info for the user from the LDAP server without actually authenticating the user. So, user password is not required.The configuration is validated before attempting to contact the server.\n\n**test_ldap_user** is required.\n\nThe active LDAP settings are not modified.\n\n",
|
|
@@ -8450,7 +8834,9 @@
|
|
|
8450
8834
|
},
|
|
8451
8835
|
"/ldap_config/test_user_auth": {
|
|
8452
8836
|
"put": {
|
|
8453
|
-
"tags": [
|
|
8837
|
+
"tags": [
|
|
8838
|
+
"Auth"
|
|
8839
|
+
],
|
|
8454
8840
|
"operationId": "test_ldap_config_user_auth",
|
|
8455
8841
|
"summary": "Test LDAP User Auth",
|
|
8456
8842
|
"description": "### Test the user authentication settings for an LDAP configuration.\n\nThis test accepts a full LDAP configuration along with a username/password pair and attempts to authenticate the user with the LDAP server. The configuration is validated before attempting the authentication.\n\nLooker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test.\n\n**test_ldap_user** and **test_ldap_password** are required.\n\nThe active LDAP settings are not modified.\n\n",
|
|
@@ -8497,7 +8883,9 @@
|
|
|
8497
8883
|
},
|
|
8498
8884
|
"/legacy_features": {
|
|
8499
8885
|
"get": {
|
|
8500
|
-
"tags": [
|
|
8886
|
+
"tags": [
|
|
8887
|
+
"Config"
|
|
8888
|
+
],
|
|
8501
8889
|
"operationId": "all_legacy_features",
|
|
8502
8890
|
"summary": "Get All Legacy Features",
|
|
8503
8891
|
"description": "### Get all legacy features.\n",
|
|
@@ -8530,7 +8918,9 @@
|
|
|
8530
8918
|
},
|
|
8531
8919
|
"/legacy_features/{legacy_feature_id}": {
|
|
8532
8920
|
"get": {
|
|
8533
|
-
"tags": [
|
|
8921
|
+
"tags": [
|
|
8922
|
+
"Config"
|
|
8923
|
+
],
|
|
8534
8924
|
"operationId": "legacy_feature",
|
|
8535
8925
|
"summary": "Get Legacy Feature",
|
|
8536
8926
|
"description": "### Get information about the legacy feature with a specific id.\n",
|
|
@@ -8568,7 +8958,9 @@
|
|
|
8568
8958
|
"x-looker-activity-type": "non_query"
|
|
8569
8959
|
},
|
|
8570
8960
|
"patch": {
|
|
8571
|
-
"tags": [
|
|
8961
|
+
"tags": [
|
|
8962
|
+
"Config"
|
|
8963
|
+
],
|
|
8572
8964
|
"operationId": "update_legacy_feature",
|
|
8573
8965
|
"summary": "Update Legacy Feature",
|
|
8574
8966
|
"description": "### Update information about the legacy feature with a specific id.\n",
|
|
@@ -8629,7 +9021,9 @@
|
|
|
8629
9021
|
},
|
|
8630
9022
|
"/locales": {
|
|
8631
9023
|
"get": {
|
|
8632
|
-
"tags": [
|
|
9024
|
+
"tags": [
|
|
9025
|
+
"Config"
|
|
9026
|
+
],
|
|
8633
9027
|
"operationId": "all_locales",
|
|
8634
9028
|
"summary": "Get All Locales",
|
|
8635
9029
|
"description": "### Get a list of locales that Looker supports.\n",
|
|
@@ -8662,7 +9056,9 @@
|
|
|
8662
9056
|
},
|
|
8663
9057
|
"/looks": {
|
|
8664
9058
|
"get": {
|
|
8665
|
-
"tags": [
|
|
9059
|
+
"tags": [
|
|
9060
|
+
"Look"
|
|
9061
|
+
],
|
|
8666
9062
|
"operationId": "all_looks",
|
|
8667
9063
|
"summary": "Get All Looks",
|
|
8668
9064
|
"description": "### Get information about all active Looks\n\nReturns an array of **abbreviated Look objects** describing all the looks that the caller has access to. Soft-deleted Looks are **not** included.\n\nGet the **full details** of a specific look by id with [look(id)](#!/Look/look)\n\nFind **soft-deleted looks** with [search_looks()](#!/Look/search_looks)\n",
|
|
@@ -8702,7 +9098,9 @@
|
|
|
8702
9098
|
"x-looker-activity-type": "non_query"
|
|
8703
9099
|
},
|
|
8704
9100
|
"post": {
|
|
8705
|
-
"tags": [
|
|
9101
|
+
"tags": [
|
|
9102
|
+
"Look"
|
|
9103
|
+
],
|
|
8706
9104
|
"operationId": "create_look",
|
|
8707
9105
|
"summary": "Create Look",
|
|
8708
9106
|
"description": "### Create a Look\n\nTo create a look to display query data, first create the query with [create_query()](#!/Query/create_query)\nthen assign the query's id to the `query_id` property in the call to `create_look()`.\n\nTo place the look into a particular space, assign the space's id to the `space_id` property\nin the call to `create_look()`.\n",
|
|
@@ -8768,7 +9166,9 @@
|
|
|
8768
9166
|
},
|
|
8769
9167
|
"/looks/search": {
|
|
8770
9168
|
"get": {
|
|
8771
|
-
"tags": [
|
|
9169
|
+
"tags": [
|
|
9170
|
+
"Look"
|
|
9171
|
+
],
|
|
8772
9172
|
"operationId": "search_looks",
|
|
8773
9173
|
"summary": "Search Looks",
|
|
8774
9174
|
"description": "### Search Looks\n\nReturns an **array of Look objects** that match the specified search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n\nGet a **single look** by id with [look(id)](#!/Look/look)\n",
|
|
@@ -8928,7 +9328,9 @@
|
|
|
8928
9328
|
},
|
|
8929
9329
|
"/looks/{look_id}": {
|
|
8930
9330
|
"get": {
|
|
8931
|
-
"tags": [
|
|
9331
|
+
"tags": [
|
|
9332
|
+
"Look"
|
|
9333
|
+
],
|
|
8932
9334
|
"operationId": "look",
|
|
8933
9335
|
"summary": "Get Look",
|
|
8934
9336
|
"description": "### Get a Look.\n\nReturns detailed information about a Look and its associated Query.\n\n",
|
|
@@ -8973,7 +9375,9 @@
|
|
|
8973
9375
|
"x-looker-activity-type": "non_query"
|
|
8974
9376
|
},
|
|
8975
9377
|
"patch": {
|
|
8976
|
-
"tags": [
|
|
9378
|
+
"tags": [
|
|
9379
|
+
"Look"
|
|
9380
|
+
],
|
|
8977
9381
|
"operationId": "update_look",
|
|
8978
9382
|
"summary": "Update Look",
|
|
8979
9383
|
"description": "### Modify a Look\n\nUse this function to modify parts of a look. Property values given in a call to `update_look` are\napplied to the existing look, so there's no need to include properties whose values are not changing.\nIt's best to specify only the properties you want to change and leave everything else out\nof your `update_look` call. **Look properties marked 'read-only' will be ignored.**\n\nWhen a user deletes a look in the Looker UI, the look data remains in the database but is\nmarked with a deleted flag (\"soft-deleted\"). Soft-deleted looks can be undeleted (by an admin)\nif the delete was in error.\n\nTo soft-delete a look via the API, use [update_look()](#!/Look/update_look) to change the look's `deleted` property to `true`.\nYou can undelete a look by calling `update_look` to change the look's `deleted` property to `false`.\n\nSoft-deleted looks are excluded from the results of [all_looks()](#!/Look/all_looks) and [search_looks()](#!/Look/search_looks), so they\nessentially disappear from view even though they still reside in the db.\nIn API 3.1 and later, you can pass `deleted: true` as a parameter to [search_looks()](#!/3.1/Look/search_looks) to list soft-deleted looks.\n\nNOTE: [delete_look()](#!/Look/delete_look) performs a \"hard delete\" - the look data is removed from the Looker\ndatabase and destroyed. There is no \"undo\" for `delete_look()`.\n",
|
|
@@ -9039,7 +9443,9 @@
|
|
|
9039
9443
|
"x-looker-activity-type": "non_query"
|
|
9040
9444
|
},
|
|
9041
9445
|
"delete": {
|
|
9042
|
-
"tags": [
|
|
9446
|
+
"tags": [
|
|
9447
|
+
"Look"
|
|
9448
|
+
],
|
|
9043
9449
|
"operationId": "delete_look",
|
|
9044
9450
|
"summary": "Delete Look",
|
|
9045
9451
|
"description": "### Permanently Delete a Look\n\nThis operation **permanently** removes a look from the Looker database.\n\nNOTE: There is no \"undo\" for this kind of delete.\n\nFor information about soft-delete (which can be undone) see [update_look()](#!/Look/update_look).\n",
|
|
@@ -9085,11 +9491,18 @@
|
|
|
9085
9491
|
},
|
|
9086
9492
|
"/looks/{look_id}/run/{result_format}": {
|
|
9087
9493
|
"get": {
|
|
9088
|
-
"tags": [
|
|
9494
|
+
"tags": [
|
|
9495
|
+
"Look"
|
|
9496
|
+
],
|
|
9089
9497
|
"operationId": "run_look",
|
|
9090
9498
|
"summary": "Run Look",
|
|
9091
9499
|
"description": "### Run a Look\n\nRuns a given look's query and returns the results in the requested format.\n\nSupported formats:\n\n| result_format | Description\n| :-----------: | :--- |\n| json | Plain json\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| md | Simple markdown\n| xlsx | MS Excel spreadsheet\n| sql | Returns the generated SQL rather than running the query\n| png | A PNG image of the visualization of the query\n| jpg | A JPG image of the visualization of the query\n\n\n",
|
|
9092
|
-
"produces": [
|
|
9500
|
+
"produces": [
|
|
9501
|
+
"text",
|
|
9502
|
+
"application/json",
|
|
9503
|
+
"image/png",
|
|
9504
|
+
"image/jpeg"
|
|
9505
|
+
],
|
|
9093
9506
|
"parameters": [
|
|
9094
9507
|
{
|
|
9095
9508
|
"name": "look_id",
|
|
@@ -9232,7 +9645,9 @@
|
|
|
9232
9645
|
},
|
|
9233
9646
|
"/lookml_models": {
|
|
9234
9647
|
"get": {
|
|
9235
|
-
"tags": [
|
|
9648
|
+
"tags": [
|
|
9649
|
+
"LookmlModel"
|
|
9650
|
+
],
|
|
9236
9651
|
"operationId": "all_lookml_models",
|
|
9237
9652
|
"summary": "Get All LookML Models",
|
|
9238
9653
|
"description": "### Get information about all lookml models.\n",
|
|
@@ -9272,7 +9687,9 @@
|
|
|
9272
9687
|
"x-looker-activity-type": "non_query"
|
|
9273
9688
|
},
|
|
9274
9689
|
"post": {
|
|
9275
|
-
"tags": [
|
|
9690
|
+
"tags": [
|
|
9691
|
+
"LookmlModel"
|
|
9692
|
+
],
|
|
9276
9693
|
"operationId": "create_lookml_model",
|
|
9277
9694
|
"summary": "Create LookML Model",
|
|
9278
9695
|
"description": "### Create a lookml model using the specified configuration.\n",
|
|
@@ -9331,7 +9748,9 @@
|
|
|
9331
9748
|
},
|
|
9332
9749
|
"/lookml_models/{lookml_model_name}": {
|
|
9333
9750
|
"get": {
|
|
9334
|
-
"tags": [
|
|
9751
|
+
"tags": [
|
|
9752
|
+
"LookmlModel"
|
|
9753
|
+
],
|
|
9335
9754
|
"operationId": "lookml_model",
|
|
9336
9755
|
"summary": "Get LookML Model",
|
|
9337
9756
|
"description": "### Get information about a lookml model.\n",
|
|
@@ -9375,7 +9794,9 @@
|
|
|
9375
9794
|
"x-looker-activity-type": "non_query"
|
|
9376
9795
|
},
|
|
9377
9796
|
"patch": {
|
|
9378
|
-
"tags": [
|
|
9797
|
+
"tags": [
|
|
9798
|
+
"LookmlModel"
|
|
9799
|
+
],
|
|
9379
9800
|
"operationId": "update_lookml_model",
|
|
9380
9801
|
"summary": "Update LookML Model",
|
|
9381
9802
|
"description": "### Update a lookml model using the specified configuration.\n",
|
|
@@ -9433,7 +9854,9 @@
|
|
|
9433
9854
|
"x-looker-activity-type": "non_query"
|
|
9434
9855
|
},
|
|
9435
9856
|
"delete": {
|
|
9436
|
-
"tags": [
|
|
9857
|
+
"tags": [
|
|
9858
|
+
"LookmlModel"
|
|
9859
|
+
],
|
|
9437
9860
|
"operationId": "delete_lookml_model",
|
|
9438
9861
|
"summary": "Delete LookML Model",
|
|
9439
9862
|
"description": "### Delete a lookml model.\n",
|
|
@@ -9478,7 +9901,9 @@
|
|
|
9478
9901
|
},
|
|
9479
9902
|
"/lookml_models/{lookml_model_name}/explores/{explore_name}": {
|
|
9480
9903
|
"get": {
|
|
9481
|
-
"tags": [
|
|
9904
|
+
"tags": [
|
|
9905
|
+
"LookmlModel"
|
|
9906
|
+
],
|
|
9482
9907
|
"operationId": "lookml_model_explore",
|
|
9483
9908
|
"summary": "Get LookML Model Explore",
|
|
9484
9909
|
"description": "### Get information about a lookml model explore.\n",
|
|
@@ -9531,7 +9956,9 @@
|
|
|
9531
9956
|
},
|
|
9532
9957
|
"/merge_queries/{merge_query_id}": {
|
|
9533
9958
|
"get": {
|
|
9534
|
-
"tags": [
|
|
9959
|
+
"tags": [
|
|
9960
|
+
"Query"
|
|
9961
|
+
],
|
|
9535
9962
|
"operationId": "merge_query",
|
|
9536
9963
|
"summary": "Get Merge Query",
|
|
9537
9964
|
"description": "### Get Merge Query\n\nReturns a merge query object given its id.\n",
|
|
@@ -9577,7 +10004,9 @@
|
|
|
9577
10004
|
},
|
|
9578
10005
|
"/merge_queries": {
|
|
9579
10006
|
"post": {
|
|
9580
|
-
"tags": [
|
|
10007
|
+
"tags": [
|
|
10008
|
+
"Query"
|
|
10009
|
+
],
|
|
9581
10010
|
"operationId": "create_merge_query",
|
|
9582
10011
|
"summary": "Create Merge Query",
|
|
9583
10012
|
"description": "### Create Merge Query\n\nCreates a new merge query object.\n\nA merge query takes the results of one or more queries and combines (merges) the results\naccording to field mapping definitions. The result is similar to a SQL left outer join.\n\nA merge query can merge results of queries from different SQL databases.\n\nThe order that queries are defined in the source_queries array property is significant. The\nfirst query in the array defines the primary key into which the results of subsequent\nqueries will be merged.\n\nLike model/view query objects, merge queries are immutable and have structural identity - if\nyou make a request to create a new merge query that is identical to an existing merge query,\nthe existing merge query will be returned instead of creating a duplicate. Conversely, any\nchange to the contents of a merge query will produce a new object with a new id.\n",
|
|
@@ -9643,7 +10072,9 @@
|
|
|
9643
10072
|
},
|
|
9644
10073
|
"/model_sets/search": {
|
|
9645
10074
|
"get": {
|
|
9646
|
-
"tags": [
|
|
10075
|
+
"tags": [
|
|
10076
|
+
"Role"
|
|
10077
|
+
],
|
|
9647
10078
|
"operationId": "search_model_sets",
|
|
9648
10079
|
"summary": "Search Model Sets",
|
|
9649
10080
|
"description": "### Search model sets\nReturns all model set records that match the given search criteria.\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -9744,7 +10175,9 @@
|
|
|
9744
10175
|
},
|
|
9745
10176
|
"/model_sets/{model_set_id}": {
|
|
9746
10177
|
"get": {
|
|
9747
|
-
"tags": [
|
|
10178
|
+
"tags": [
|
|
10179
|
+
"Role"
|
|
10180
|
+
],
|
|
9748
10181
|
"operationId": "model_set",
|
|
9749
10182
|
"summary": "Get Model Set",
|
|
9750
10183
|
"description": "### Get information about the model set with a specific id.\n",
|
|
@@ -9789,7 +10222,9 @@
|
|
|
9789
10222
|
"x-looker-activity-type": "non_query"
|
|
9790
10223
|
},
|
|
9791
10224
|
"delete": {
|
|
9792
|
-
"tags": [
|
|
10225
|
+
"tags": [
|
|
10226
|
+
"Role"
|
|
10227
|
+
],
|
|
9793
10228
|
"operationId": "delete_model_set",
|
|
9794
10229
|
"summary": "Delete Model Set",
|
|
9795
10230
|
"description": "### Delete the model set with a specific id.\n",
|
|
@@ -9833,7 +10268,9 @@
|
|
|
9833
10268
|
"x-looker-activity-type": "non_query"
|
|
9834
10269
|
},
|
|
9835
10270
|
"patch": {
|
|
9836
|
-
"tags": [
|
|
10271
|
+
"tags": [
|
|
10272
|
+
"Role"
|
|
10273
|
+
],
|
|
9837
10274
|
"operationId": "update_model_set",
|
|
9838
10275
|
"summary": "Update Model Set",
|
|
9839
10276
|
"description": "### Update information about the model set with a specific id.\n",
|
|
@@ -9894,7 +10331,9 @@
|
|
|
9894
10331
|
},
|
|
9895
10332
|
"/model_sets": {
|
|
9896
10333
|
"get": {
|
|
9897
|
-
"tags": [
|
|
10334
|
+
"tags": [
|
|
10335
|
+
"Role"
|
|
10336
|
+
],
|
|
9898
10337
|
"operationId": "all_model_sets",
|
|
9899
10338
|
"summary": "Get All Model Sets",
|
|
9900
10339
|
"description": "### Get information about all model sets.\n",
|
|
@@ -9928,7 +10367,9 @@
|
|
|
9928
10367
|
"x-looker-activity-type": "non_query"
|
|
9929
10368
|
},
|
|
9930
10369
|
"post": {
|
|
9931
|
-
"tags": [
|
|
10370
|
+
"tags": [
|
|
10371
|
+
"Role"
|
|
10372
|
+
],
|
|
9932
10373
|
"operationId": "create_model_set",
|
|
9933
10374
|
"summary": "Create Model Set",
|
|
9934
10375
|
"description": "### Create a model set with the specified information. Model sets are used by Roles.\n",
|
|
@@ -9981,7 +10422,9 @@
|
|
|
9981
10422
|
},
|
|
9982
10423
|
"/oidc_config": {
|
|
9983
10424
|
"get": {
|
|
9984
|
-
"tags": [
|
|
10425
|
+
"tags": [
|
|
10426
|
+
"Auth"
|
|
10427
|
+
],
|
|
9985
10428
|
"operationId": "oidc_config",
|
|
9986
10429
|
"summary": "Get OIDC Configuration",
|
|
9987
10430
|
"description": "### Get the OIDC configuration.\n\nLooker can be optionally configured to authenticate users against an OpenID Connect (OIDC)\nauthentication server. OIDC setup requires coordination with an administrator of that server.\n\nOnly Looker administrators can read and update the OIDC configuration.\n\nConfiguring OIDC impacts authentication for all users. This configuration should be done carefully.\n\nLooker maintains a single OIDC configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct).\n\nOIDC is enabled or disabled for Looker using the **enabled** field.\n",
|
|
@@ -10003,7 +10446,9 @@
|
|
|
10003
10446
|
"x-looker-activity-type": "non_query"
|
|
10004
10447
|
},
|
|
10005
10448
|
"patch": {
|
|
10006
|
-
"tags": [
|
|
10449
|
+
"tags": [
|
|
10450
|
+
"Auth"
|
|
10451
|
+
],
|
|
10007
10452
|
"operationId": "update_oidc_config",
|
|
10008
10453
|
"summary": "Update OIDC Configuration",
|
|
10009
10454
|
"description": "### Update the OIDC configuration.\n\nConfiguring OIDC impacts authentication for all users. This configuration should be done carefully.\n\nOnly Looker administrators can read and update the OIDC configuration.\n\nOIDC is enabled or disabled for Looker using the **enabled** field.\n\nIt is **highly** recommended that any OIDC setting changes be tested using the APIs below before being set globally.\n",
|
|
@@ -10050,7 +10495,9 @@
|
|
|
10050
10495
|
},
|
|
10051
10496
|
"/oidc_test_configs/{test_slug}": {
|
|
10052
10497
|
"get": {
|
|
10053
|
-
"tags": [
|
|
10498
|
+
"tags": [
|
|
10499
|
+
"Auth"
|
|
10500
|
+
],
|
|
10054
10501
|
"operationId": "oidc_test_config",
|
|
10055
10502
|
"summary": "Get OIDC Test Configuration",
|
|
10056
10503
|
"description": "### Get a OIDC test configuration by test_slug.\n",
|
|
@@ -10081,7 +10528,9 @@
|
|
|
10081
10528
|
"x-looker-activity-type": "non_query"
|
|
10082
10529
|
},
|
|
10083
10530
|
"delete": {
|
|
10084
|
-
"tags": [
|
|
10531
|
+
"tags": [
|
|
10532
|
+
"Auth"
|
|
10533
|
+
],
|
|
10085
10534
|
"operationId": "delete_oidc_test_config",
|
|
10086
10535
|
"summary": "Delete OIDC Test Configuration",
|
|
10087
10536
|
"description": "### Delete a OIDC test configuration.\n",
|
|
@@ -10120,7 +10569,9 @@
|
|
|
10120
10569
|
},
|
|
10121
10570
|
"/oidc_test_configs": {
|
|
10122
10571
|
"post": {
|
|
10123
|
-
"tags": [
|
|
10572
|
+
"tags": [
|
|
10573
|
+
"Auth"
|
|
10574
|
+
],
|
|
10124
10575
|
"operationId": "create_oidc_test_config",
|
|
10125
10576
|
"summary": "Create OIDC Test Configuration",
|
|
10126
10577
|
"description": "### Create a OIDC test configuration.\n",
|
|
@@ -10167,7 +10618,9 @@
|
|
|
10167
10618
|
},
|
|
10168
10619
|
"/password_config": {
|
|
10169
10620
|
"get": {
|
|
10170
|
-
"tags": [
|
|
10621
|
+
"tags": [
|
|
10622
|
+
"Auth"
|
|
10623
|
+
],
|
|
10171
10624
|
"operationId": "password_config",
|
|
10172
10625
|
"summary": "Get Password Config",
|
|
10173
10626
|
"description": "### Get password config.\n",
|
|
@@ -10195,7 +10648,9 @@
|
|
|
10195
10648
|
"x-looker-activity-type": "non_query"
|
|
10196
10649
|
},
|
|
10197
10650
|
"patch": {
|
|
10198
|
-
"tags": [
|
|
10651
|
+
"tags": [
|
|
10652
|
+
"Auth"
|
|
10653
|
+
],
|
|
10199
10654
|
"operationId": "update_password_config",
|
|
10200
10655
|
"summary": "Update Password Config",
|
|
10201
10656
|
"description": "### Update password config.\n",
|
|
@@ -10248,7 +10703,9 @@
|
|
|
10248
10703
|
},
|
|
10249
10704
|
"/password_config/force_password_reset_at_next_login_for_all_users": {
|
|
10250
10705
|
"put": {
|
|
10251
|
-
"tags": [
|
|
10706
|
+
"tags": [
|
|
10707
|
+
"Auth"
|
|
10708
|
+
],
|
|
10252
10709
|
"operationId": "force_password_reset_at_next_login_for_all_users",
|
|
10253
10710
|
"summary": "Force password reset",
|
|
10254
10711
|
"description": "### Force all credentials_email users to reset their login passwords upon their next login.\n",
|
|
@@ -10290,7 +10747,9 @@
|
|
|
10290
10747
|
},
|
|
10291
10748
|
"/permissions": {
|
|
10292
10749
|
"get": {
|
|
10293
|
-
"tags": [
|
|
10750
|
+
"tags": [
|
|
10751
|
+
"Role"
|
|
10752
|
+
],
|
|
10294
10753
|
"operationId": "all_permissions",
|
|
10295
10754
|
"summary": "Get All Permissions",
|
|
10296
10755
|
"description": "### Get all supported permissions.\n",
|
|
@@ -10323,7 +10782,9 @@
|
|
|
10323
10782
|
},
|
|
10324
10783
|
"/permission_sets/search": {
|
|
10325
10784
|
"get": {
|
|
10326
|
-
"tags": [
|
|
10785
|
+
"tags": [
|
|
10786
|
+
"Role"
|
|
10787
|
+
],
|
|
10327
10788
|
"operationId": "search_permission_sets",
|
|
10328
10789
|
"summary": "Search Permission Sets",
|
|
10329
10790
|
"description": "### Search permission sets\nReturns all permission set records that match the given search criteria.\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -10424,7 +10885,9 @@
|
|
|
10424
10885
|
},
|
|
10425
10886
|
"/permission_sets/{permission_set_id}": {
|
|
10426
10887
|
"get": {
|
|
10427
|
-
"tags": [
|
|
10888
|
+
"tags": [
|
|
10889
|
+
"Role"
|
|
10890
|
+
],
|
|
10428
10891
|
"operationId": "permission_set",
|
|
10429
10892
|
"summary": "Get Permission Set",
|
|
10430
10893
|
"description": "### Get information about the permission set with a specific id.\n",
|
|
@@ -10469,7 +10932,9 @@
|
|
|
10469
10932
|
"x-looker-activity-type": "non_query"
|
|
10470
10933
|
},
|
|
10471
10934
|
"delete": {
|
|
10472
|
-
"tags": [
|
|
10935
|
+
"tags": [
|
|
10936
|
+
"Role"
|
|
10937
|
+
],
|
|
10473
10938
|
"operationId": "delete_permission_set",
|
|
10474
10939
|
"summary": "Delete Permission Set",
|
|
10475
10940
|
"description": "### Delete the permission set with a specific id.\n",
|
|
@@ -10519,7 +10984,9 @@
|
|
|
10519
10984
|
"x-looker-activity-type": "non_query"
|
|
10520
10985
|
},
|
|
10521
10986
|
"patch": {
|
|
10522
|
-
"tags": [
|
|
10987
|
+
"tags": [
|
|
10988
|
+
"Role"
|
|
10989
|
+
],
|
|
10523
10990
|
"operationId": "update_permission_set",
|
|
10524
10991
|
"summary": "Update Permission Set",
|
|
10525
10992
|
"description": "### Update information about the permission set with a specific id.\n",
|
|
@@ -10586,7 +11053,9 @@
|
|
|
10586
11053
|
},
|
|
10587
11054
|
"/permission_sets": {
|
|
10588
11055
|
"get": {
|
|
10589
|
-
"tags": [
|
|
11056
|
+
"tags": [
|
|
11057
|
+
"Role"
|
|
11058
|
+
],
|
|
10590
11059
|
"operationId": "all_permission_sets",
|
|
10591
11060
|
"summary": "Get All Permission Sets",
|
|
10592
11061
|
"description": "### Get information about all permission sets.\n",
|
|
@@ -10626,7 +11095,9 @@
|
|
|
10626
11095
|
"x-looker-activity-type": "non_query"
|
|
10627
11096
|
},
|
|
10628
11097
|
"post": {
|
|
10629
|
-
"tags": [
|
|
11098
|
+
"tags": [
|
|
11099
|
+
"Role"
|
|
11100
|
+
],
|
|
10630
11101
|
"operationId": "create_permission_set",
|
|
10631
11102
|
"summary": "Create Permission Set",
|
|
10632
11103
|
"description": "### Create a permission set with the specified information. Permission sets are used by Roles.\n",
|
|
@@ -10685,7 +11156,9 @@
|
|
|
10685
11156
|
},
|
|
10686
11157
|
"/projects/{project_id}/deploy_ref_to_production": {
|
|
10687
11158
|
"post": {
|
|
10688
|
-
"tags": [
|
|
11159
|
+
"tags": [
|
|
11160
|
+
"Project"
|
|
11161
|
+
],
|
|
10689
11162
|
"operationId": "deploy_ref_to_production",
|
|
10690
11163
|
"summary": "Deploy Remote Branch or Ref to Production",
|
|
10691
11164
|
"description": "### Deploy a Remote Branch or Ref to Production\n\nGit must have been configured and deploy permission required.\n\nDeploy is a one/two step process\n1. If this is the first deploy of this project, create the production project with git repository.\n2. Pull the branch or ref into the production project.\n\nCan only specify either a branch or a ref.\n\n",
|
|
@@ -10753,7 +11226,9 @@
|
|
|
10753
11226
|
},
|
|
10754
11227
|
"/projects/{project_id}/deploy_to_production": {
|
|
10755
11228
|
"post": {
|
|
10756
|
-
"tags": [
|
|
11229
|
+
"tags": [
|
|
11230
|
+
"Project"
|
|
11231
|
+
],
|
|
10757
11232
|
"operationId": "deploy_to_production",
|
|
10758
11233
|
"summary": "Deploy To Production",
|
|
10759
11234
|
"description": "### Deploy LookML from this Development Mode Project to Production\n\nGit must have been configured, must be in dev mode and deploy permission required\n\nDeploy is a two / three step process:\n\n1. Push commits in current branch of dev mode project to the production branch (origin/master).\n Note a. This step is skipped in read-only projects.\n Note b. If this step is unsuccessful for any reason (e.g. rejected non-fastforward because production branch has\n commits not in current branch), subsequent steps will be skipped.\n2. If this is the first deploy of this project, create the production project with git repository.\n3. Pull the production branch into the production project.\n\n",
|
|
@@ -10807,7 +11282,9 @@
|
|
|
10807
11282
|
},
|
|
10808
11283
|
"/projects/{project_id}/reset_to_production": {
|
|
10809
11284
|
"post": {
|
|
10810
|
-
"tags": [
|
|
11285
|
+
"tags": [
|
|
11286
|
+
"Project"
|
|
11287
|
+
],
|
|
10811
11288
|
"operationId": "reset_project_to_production",
|
|
10812
11289
|
"summary": "Reset To Production",
|
|
10813
11290
|
"description": "### Reset a project to the revision of the project that is in production.\n\n**DANGER** this will delete any changes that have not been pushed to a remote repository.\n",
|
|
@@ -10861,7 +11338,9 @@
|
|
|
10861
11338
|
},
|
|
10862
11339
|
"/projects/{project_id}/reset_to_remote": {
|
|
10863
11340
|
"post": {
|
|
10864
|
-
"tags": [
|
|
11341
|
+
"tags": [
|
|
11342
|
+
"Project"
|
|
11343
|
+
],
|
|
10865
11344
|
"operationId": "reset_project_to_remote",
|
|
10866
11345
|
"summary": "Reset To Remote",
|
|
10867
11346
|
"description": "### Reset a project development branch to the revision of the project that is on the remote.\n\n**DANGER** this will delete any changes that have not been pushed to a remote repository.\n",
|
|
@@ -10915,7 +11394,9 @@
|
|
|
10915
11394
|
},
|
|
10916
11395
|
"/projects": {
|
|
10917
11396
|
"get": {
|
|
10918
|
-
"tags": [
|
|
11397
|
+
"tags": [
|
|
11398
|
+
"Project"
|
|
11399
|
+
],
|
|
10919
11400
|
"operationId": "all_projects",
|
|
10920
11401
|
"summary": "Get All Projects",
|
|
10921
11402
|
"description": "### Get All Projects\n\nReturns all projects visible to the current user\n",
|
|
@@ -10955,7 +11436,9 @@
|
|
|
10955
11436
|
"x-looker-activity-type": "non_query"
|
|
10956
11437
|
},
|
|
10957
11438
|
"post": {
|
|
10958
|
-
"tags": [
|
|
11439
|
+
"tags": [
|
|
11440
|
+
"Project"
|
|
11441
|
+
],
|
|
10959
11442
|
"operationId": "create_project",
|
|
10960
11443
|
"summary": "Create Project",
|
|
10961
11444
|
"description": "### Create A Project\n\ndev mode required.\n- Call `update_session` to select the 'dev' workspace.\n\n`name` is required.\n`git_remote_url` is not allowed. To configure Git for the newly created project, follow the instructions in `update_project`.\n\n",
|
|
@@ -11014,7 +11497,9 @@
|
|
|
11014
11497
|
},
|
|
11015
11498
|
"/projects/{project_id}": {
|
|
11016
11499
|
"get": {
|
|
11017
|
-
"tags": [
|
|
11500
|
+
"tags": [
|
|
11501
|
+
"Project"
|
|
11502
|
+
],
|
|
11018
11503
|
"operationId": "project",
|
|
11019
11504
|
"summary": "Get Project",
|
|
11020
11505
|
"description": "### Get A Project\n\nReturns the project with the given project id\n",
|
|
@@ -11058,7 +11543,9 @@
|
|
|
11058
11543
|
"x-looker-activity-type": "non_query"
|
|
11059
11544
|
},
|
|
11060
11545
|
"patch": {
|
|
11061
|
-
"tags": [
|
|
11546
|
+
"tags": [
|
|
11547
|
+
"Project"
|
|
11548
|
+
],
|
|
11062
11549
|
"operationId": "update_project",
|
|
11063
11550
|
"summary": "Update Project",
|
|
11064
11551
|
"description": "### Update Project Configuration\n\nApply changes to a project's configuration.\n\n\n#### Configuring Git for a Project\n\nTo set up a Looker project with a remote git repository, follow these steps:\n\n1. Call `update_session` to select the 'dev' workspace.\n1. Call `create_git_deploy_key` to create a new deploy key for the project\n1. Copy the deploy key text into the remote git repository's ssh key configuration\n1. Call `update_project` to set project's `git_remote_url` ()and `git_service_name`, if necessary).\n\nWhen you modify a project's `git_remote_url`, Looker connects to the remote repository to fetch\nmetadata. The remote git repository MUST be configured with the Looker-generated deploy\nkey for this project prior to setting the project's `git_remote_url`.\n\nTo set up a Looker project with a git repository residing on the Looker server (a 'bare' git repo):\n\n1. Call `update_session` to select the 'dev' workspace.\n1. Call `update_project` setting `git_remote_url` to null and `git_service_name` to \"bare\".\n\n",
|
|
@@ -11137,7 +11624,9 @@
|
|
|
11137
11624
|
},
|
|
11138
11625
|
"/projects/{project_id}/manifest": {
|
|
11139
11626
|
"get": {
|
|
11140
|
-
"tags": [
|
|
11627
|
+
"tags": [
|
|
11628
|
+
"Project"
|
|
11629
|
+
],
|
|
11141
11630
|
"operationId": "manifest",
|
|
11142
11631
|
"summary": "Get Manifest",
|
|
11143
11632
|
"description": "### Get A Projects Manifest object\n\nReturns the project with the given project id\n",
|
|
@@ -11176,11 +11665,15 @@
|
|
|
11176
11665
|
},
|
|
11177
11666
|
"/projects/{project_id}/git/deploy_key": {
|
|
11178
11667
|
"post": {
|
|
11179
|
-
"tags": [
|
|
11668
|
+
"tags": [
|
|
11669
|
+
"Project"
|
|
11670
|
+
],
|
|
11180
11671
|
"operationId": "create_git_deploy_key",
|
|
11181
11672
|
"summary": "Create Deploy Key",
|
|
11182
11673
|
"description": "### Create Git Deploy Key\n\nCreate a public/private key pair for authenticating ssh git requests from Looker to a remote git repository\nfor a particular Looker project.\n\nReturns the public key of the generated ssh key pair.\n\nCopy this public key to your remote git repository's ssh keys configuration so that the remote git service can\nvalidate and accept git requests from the Looker server.\n",
|
|
11183
|
-
"produces": [
|
|
11674
|
+
"produces": [
|
|
11675
|
+
"text/plain"
|
|
11676
|
+
],
|
|
11184
11677
|
"parameters": [
|
|
11185
11678
|
{
|
|
11186
11679
|
"name": "project_id",
|
|
@@ -11232,11 +11725,15 @@
|
|
|
11232
11725
|
"x-looker-activity-type": "non_query"
|
|
11233
11726
|
},
|
|
11234
11727
|
"get": {
|
|
11235
|
-
"tags": [
|
|
11728
|
+
"tags": [
|
|
11729
|
+
"Project"
|
|
11730
|
+
],
|
|
11236
11731
|
"operationId": "git_deploy_key",
|
|
11237
11732
|
"summary": "Git Deploy Key",
|
|
11238
11733
|
"description": "### Git Deploy Key\n\nReturns the ssh public key previously created for a project's git repository.\n",
|
|
11239
|
-
"produces": [
|
|
11734
|
+
"produces": [
|
|
11735
|
+
"text/plain"
|
|
11736
|
+
],
|
|
11240
11737
|
"parameters": [
|
|
11241
11738
|
{
|
|
11242
11739
|
"name": "project_id",
|
|
@@ -11272,7 +11769,9 @@
|
|
|
11272
11769
|
},
|
|
11273
11770
|
"/projects/{project_id}/validate": {
|
|
11274
11771
|
"post": {
|
|
11275
|
-
"tags": [
|
|
11772
|
+
"tags": [
|
|
11773
|
+
"Project"
|
|
11774
|
+
],
|
|
11276
11775
|
"operationId": "validate_project",
|
|
11277
11776
|
"summary": "Validate Project",
|
|
11278
11777
|
"description": "### Validate Project\n\nPerforms lint validation of all lookml files in the project.\nReturns a list of errors found, if any.\n\nValidating the content of all the files in a project can be computationally intensive\nfor large projects. For best performance, call `validate_project(project_id)` only\nwhen you really want to recompute project validation. To quickly display the results of\nthe most recent project validation (without recomputing), use `project_validation_results(project_id)`\n",
|
|
@@ -11328,7 +11827,9 @@
|
|
|
11328
11827
|
"x-looker-activity-type": "non_query"
|
|
11329
11828
|
},
|
|
11330
11829
|
"get": {
|
|
11331
|
-
"tags": [
|
|
11830
|
+
"tags": [
|
|
11831
|
+
"Project"
|
|
11832
|
+
],
|
|
11332
11833
|
"operationId": "project_validation_results",
|
|
11333
11834
|
"summary": "Cached Project Validation Results",
|
|
11334
11835
|
"description": "### Get Cached Project Validation Results\n\nReturns the cached results of a previous project validation calculation, if any.\nReturns http status 204 No Content if no validation results exist.\n\nValidating the content of all the files in a project can be computationally intensive\nfor large projects. Use this API to simply fetch the results of the most recent\nproject validation rather than revalidating the entire project from scratch.\n\nA value of `\"stale\": true` in the response indicates that the project has changed since\nthe cached validation results were computed. The cached validation results may no longer\nreflect the current state of the project.\n",
|
|
@@ -11377,7 +11878,9 @@
|
|
|
11377
11878
|
},
|
|
11378
11879
|
"/projects/{project_id}/current_workspace": {
|
|
11379
11880
|
"get": {
|
|
11380
|
-
"tags": [
|
|
11881
|
+
"tags": [
|
|
11882
|
+
"Project"
|
|
11883
|
+
],
|
|
11381
11884
|
"operationId": "project_workspace",
|
|
11382
11885
|
"summary": "Get Project Workspace",
|
|
11383
11886
|
"description": "### Get Project Workspace\n\nReturns information about the state of the project files in the currently selected workspace\n",
|
|
@@ -11423,7 +11926,9 @@
|
|
|
11423
11926
|
},
|
|
11424
11927
|
"/projects/{project_id}/files": {
|
|
11425
11928
|
"get": {
|
|
11426
|
-
"tags": [
|
|
11929
|
+
"tags": [
|
|
11930
|
+
"Project"
|
|
11931
|
+
],
|
|
11427
11932
|
"operationId": "all_project_files",
|
|
11428
11933
|
"summary": "Get All Project Files",
|
|
11429
11934
|
"description": "### Get All Project Files\n\nReturns a list of the files in the project\n",
|
|
@@ -11472,7 +11977,9 @@
|
|
|
11472
11977
|
},
|
|
11473
11978
|
"/projects/{project_id}/files/file": {
|
|
11474
11979
|
"get": {
|
|
11475
|
-
"tags": [
|
|
11980
|
+
"tags": [
|
|
11981
|
+
"Project"
|
|
11982
|
+
],
|
|
11476
11983
|
"operationId": "project_file",
|
|
11477
11984
|
"summary": "Get Project File",
|
|
11478
11985
|
"description": "### Get Project File Info\n\nReturns information about a file in the project\n",
|
|
@@ -11525,7 +12032,9 @@
|
|
|
11525
12032
|
},
|
|
11526
12033
|
"/projects/{project_id}/git_connection_tests": {
|
|
11527
12034
|
"get": {
|
|
11528
|
-
"tags": [
|
|
12035
|
+
"tags": [
|
|
12036
|
+
"Project"
|
|
12037
|
+
],
|
|
11529
12038
|
"operationId": "all_git_connection_tests",
|
|
11530
12039
|
"summary": "Get All Git Connection Tests",
|
|
11531
12040
|
"description": "### Get All Git Connection Tests\n\ndev mode required.\n - Call `update_session` to select the 'dev' workspace.\n\nReturns a list of tests which can be run against a project's (or the dependency project for the provided remote_url) git connection. Call [Run Git Connection Test](#!/Project/run_git_connection_test) to execute each test in sequence.\n\nTests are ordered by increasing specificity. Tests should be run in the order returned because later tests require functionality tested by tests earlier in the test list.\n\nFor example, a late-stage test for write access is meaningless if connecting to the git server (an early test) is failing.\n",
|
|
@@ -11574,7 +12083,9 @@
|
|
|
11574
12083
|
},
|
|
11575
12084
|
"/projects/{project_id}/git_connection_tests/{test_id}": {
|
|
11576
12085
|
"get": {
|
|
11577
|
-
"tags": [
|
|
12086
|
+
"tags": [
|
|
12087
|
+
"Project"
|
|
12088
|
+
],
|
|
11578
12089
|
"operationId": "run_git_connection_test",
|
|
11579
12090
|
"summary": "Run Git Connection Test",
|
|
11580
12091
|
"description": "### Run a git connection test\n\nRun the named test on the git service used by this project (or the dependency project for the provided remote_url) and return the result. This\nis intended to help debug git connections when things do not work properly, to give\nmore helpful information about why a git url is not working with Looker.\n\nTests should be run in the order they are returned by [Get All Git Connection Tests](#!/Project/all_git_connection_tests).\n",
|
|
@@ -11646,7 +12157,9 @@
|
|
|
11646
12157
|
},
|
|
11647
12158
|
"/projects/{project_id}/lookml_tests": {
|
|
11648
12159
|
"get": {
|
|
11649
|
-
"tags": [
|
|
12160
|
+
"tags": [
|
|
12161
|
+
"Project"
|
|
12162
|
+
],
|
|
11650
12163
|
"operationId": "all_lookml_tests",
|
|
11651
12164
|
"summary": "Get All LookML Tests",
|
|
11652
12165
|
"description": "### Get All LookML Tests\n\nReturns a list of tests which can be run to validate a project's LookML code and/or the underlying data,\noptionally filtered by the file id.\nCall [Run LookML Test](#!/Project/run_lookml_test) to execute tests.\n",
|
|
@@ -11695,7 +12208,9 @@
|
|
|
11695
12208
|
},
|
|
11696
12209
|
"/projects/{project_id}/lookml_tests/run": {
|
|
11697
12210
|
"get": {
|
|
11698
|
-
"tags": [
|
|
12211
|
+
"tags": [
|
|
12212
|
+
"Project"
|
|
12213
|
+
],
|
|
11699
12214
|
"operationId": "run_lookml_test",
|
|
11700
12215
|
"summary": "Run LookML Test",
|
|
11701
12216
|
"description": "### Run LookML Tests\n\nRuns all tests in the project, optionally filtered by file, test, and/or model.\n",
|
|
@@ -11770,7 +12285,9 @@
|
|
|
11770
12285
|
},
|
|
11771
12286
|
"/projects/{project_id}/tag": {
|
|
11772
12287
|
"post": {
|
|
11773
|
-
"tags": [
|
|
12288
|
+
"tags": [
|
|
12289
|
+
"Project"
|
|
12290
|
+
],
|
|
11774
12291
|
"operationId": "tag_ref",
|
|
11775
12292
|
"summary": "Tag Ref",
|
|
11776
12293
|
"description": "### Creates a tag for the most recent commit, or a specific ref is a SHA is provided\n\nThis is an internal-only, undocumented route.\n",
|
|
@@ -11860,7 +12377,9 @@
|
|
|
11860
12377
|
},
|
|
11861
12378
|
"/render_tasks/lookml_dashboards/{dashboard_id}/{result_format}": {
|
|
11862
12379
|
"post": {
|
|
11863
|
-
"tags": [
|
|
12380
|
+
"tags": [
|
|
12381
|
+
"RenderTask"
|
|
12382
|
+
],
|
|
11864
12383
|
"operationId": "create_lookml_dashboard_render_task",
|
|
11865
12384
|
"summary": "Create Lookml Dashboard Render Task",
|
|
11866
12385
|
"description": "### Create a new task to render a lookml dashboard to a document or image.\n\n# DEPRECATED: Use [create_dashboard_render_task()](#!/RenderTask/create_dashboard_render_task) in API 4.0+\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).\n\n",
|
|
@@ -11971,7 +12490,9 @@
|
|
|
11971
12490
|
},
|
|
11972
12491
|
"/render_tasks/looks/{look_id}/{result_format}": {
|
|
11973
12492
|
"post": {
|
|
11974
|
-
"tags": [
|
|
12493
|
+
"tags": [
|
|
12494
|
+
"RenderTask"
|
|
12495
|
+
],
|
|
11975
12496
|
"operationId": "create_look_render_task",
|
|
11976
12497
|
"summary": "Create Look Render Task",
|
|
11977
12498
|
"description": "### Create a new task to render a look to an image.\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).\n\n",
|
|
@@ -12059,7 +12580,9 @@
|
|
|
12059
12580
|
},
|
|
12060
12581
|
"/render_tasks/queries/{query_id}/{result_format}": {
|
|
12061
12582
|
"post": {
|
|
12062
|
-
"tags": [
|
|
12583
|
+
"tags": [
|
|
12584
|
+
"RenderTask"
|
|
12585
|
+
],
|
|
12063
12586
|
"operationId": "create_query_render_task",
|
|
12064
12587
|
"summary": "Create Query Render Task",
|
|
12065
12588
|
"description": "### Create a new task to render an existing query to an image.\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).\n\n",
|
|
@@ -12147,7 +12670,9 @@
|
|
|
12147
12670
|
},
|
|
12148
12671
|
"/render_tasks/dashboards/{dashboard_id}/{result_format}": {
|
|
12149
12672
|
"post": {
|
|
12150
|
-
"tags": [
|
|
12673
|
+
"tags": [
|
|
12674
|
+
"RenderTask"
|
|
12675
|
+
],
|
|
12151
12676
|
"operationId": "create_dashboard_render_task",
|
|
12152
12677
|
"summary": "Create Dashboard Render Task",
|
|
12153
12678
|
"description": "### Create a new task to render a dashboard to a document or image.\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).\n\n",
|
|
@@ -12258,7 +12783,9 @@
|
|
|
12258
12783
|
},
|
|
12259
12784
|
"/render_tasks/{render_task_id}": {
|
|
12260
12785
|
"get": {
|
|
12261
|
-
"tags": [
|
|
12786
|
+
"tags": [
|
|
12787
|
+
"RenderTask"
|
|
12788
|
+
],
|
|
12262
12789
|
"operationId": "render_task",
|
|
12263
12790
|
"summary": "Get Render Task",
|
|
12264
12791
|
"description": "### Get information about a render task.\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).\n\n",
|
|
@@ -12304,11 +12831,17 @@
|
|
|
12304
12831
|
},
|
|
12305
12832
|
"/render_tasks/{render_task_id}/results": {
|
|
12306
12833
|
"get": {
|
|
12307
|
-
"tags": [
|
|
12834
|
+
"tags": [
|
|
12835
|
+
"RenderTask"
|
|
12836
|
+
],
|
|
12308
12837
|
"operationId": "render_task_results",
|
|
12309
12838
|
"summary": "Render Task Results",
|
|
12310
12839
|
"description": "### Get the document or image produced by a completed render task.\n\nNote that the PDF or image result will be a binary blob in the HTTP response, as indicated by the\nContent-Type in the response headers. This may require specialized (or at least different) handling than text\nresponses such as JSON. You may need to tell your HTTP client that the response is binary so that it does not\nattempt to parse the binary data as text.\n\nIf the render task exists but has not finished rendering the results, the response HTTP status will be\n**202 Accepted**, the response body will be empty, and the response will have a Retry-After header indicating\nthat the caller should repeat the request at a later time.\n\nReturns 404 if the render task cannot be found, if the cached result has expired, or if the caller\ndoes not have permission to view the results.\n\nFor detailed information about the status of the render task, use [Render Task](#!/RenderTask/render_task).\nPolling loops waiting for completion of a render task would be better served by polling **render_task(id)** until\nthe task status reaches completion (or error) instead of polling **render_task_results(id)** alone.\n",
|
|
12311
|
-
"produces": [
|
|
12840
|
+
"produces": [
|
|
12841
|
+
"image/jpeg",
|
|
12842
|
+
"image/png",
|
|
12843
|
+
"application/pdf"
|
|
12844
|
+
],
|
|
12312
12845
|
"parameters": [
|
|
12313
12846
|
{
|
|
12314
12847
|
"name": "render_task_id",
|
|
@@ -12347,7 +12880,9 @@
|
|
|
12347
12880
|
},
|
|
12348
12881
|
"/projects/{root_project_id}/credential/{credential_id}": {
|
|
12349
12882
|
"put": {
|
|
12350
|
-
"tags": [
|
|
12883
|
+
"tags": [
|
|
12884
|
+
"Project"
|
|
12885
|
+
],
|
|
12351
12886
|
"operationId": "update_repository_credential",
|
|
12352
12887
|
"summary": "Create Repository Credential",
|
|
12353
12888
|
"description": "### Configure Repository Credential for a remote dependency\n\nAdmin required.\n\n`root_project_id` is required.\n`credential_id` is required.\n\n",
|
|
@@ -12418,7 +12953,9 @@
|
|
|
12418
12953
|
"x-looker-activity-type": "non_query"
|
|
12419
12954
|
},
|
|
12420
12955
|
"delete": {
|
|
12421
|
-
"tags": [
|
|
12956
|
+
"tags": [
|
|
12957
|
+
"Project"
|
|
12958
|
+
],
|
|
12422
12959
|
"operationId": "delete_repository_credential",
|
|
12423
12960
|
"summary": "Delete Repository Credential",
|
|
12424
12961
|
"description": "### Repository Credential for a remote dependency\n\nAdmin required.\n\n`root_project_id` is required.\n`credential_id` is required.\n",
|
|
@@ -12470,7 +13007,9 @@
|
|
|
12470
13007
|
},
|
|
12471
13008
|
"/projects/{root_project_id}/credentials": {
|
|
12472
13009
|
"get": {
|
|
12473
|
-
"tags": [
|
|
13010
|
+
"tags": [
|
|
13011
|
+
"Project"
|
|
13012
|
+
],
|
|
12474
13013
|
"operationId": "get_all_repository_credentials",
|
|
12475
13014
|
"summary": "Get All Repository Credentials",
|
|
12476
13015
|
"description": "### Get all Repository Credentials for a project\n\n`root_project_id` is required.\n",
|
|
@@ -12512,7 +13051,9 @@
|
|
|
12512
13051
|
},
|
|
12513
13052
|
"/roles": {
|
|
12514
13053
|
"get": {
|
|
12515
|
-
"tags": [
|
|
13054
|
+
"tags": [
|
|
13055
|
+
"Role"
|
|
13056
|
+
],
|
|
12516
13057
|
"operationId": "all_roles",
|
|
12517
13058
|
"summary": "Get All Roles",
|
|
12518
13059
|
"description": "### Get information about all roles.\n",
|
|
@@ -12564,7 +13105,9 @@
|
|
|
12564
13105
|
"x-looker-activity-type": "non_query"
|
|
12565
13106
|
},
|
|
12566
13107
|
"post": {
|
|
12567
|
-
"tags": [
|
|
13108
|
+
"tags": [
|
|
13109
|
+
"Role"
|
|
13110
|
+
],
|
|
12568
13111
|
"operationId": "create_role",
|
|
12569
13112
|
"summary": "Create Role",
|
|
12570
13113
|
"description": "### Create a role with the specified information.\n",
|
|
@@ -12623,7 +13166,9 @@
|
|
|
12623
13166
|
},
|
|
12624
13167
|
"/roles/search": {
|
|
12625
13168
|
"get": {
|
|
12626
|
-
"tags": [
|
|
13169
|
+
"tags": [
|
|
13170
|
+
"Role"
|
|
13171
|
+
],
|
|
12627
13172
|
"operationId": "search_roles",
|
|
12628
13173
|
"summary": "Search Roles",
|
|
12629
13174
|
"description": "### Search roles\n\nReturns all role records that match the given search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n",
|
|
@@ -12717,7 +13262,9 @@
|
|
|
12717
13262
|
},
|
|
12718
13263
|
"/roles/{role_id}": {
|
|
12719
13264
|
"get": {
|
|
12720
|
-
"tags": [
|
|
13265
|
+
"tags": [
|
|
13266
|
+
"Role"
|
|
13267
|
+
],
|
|
12721
13268
|
"operationId": "role",
|
|
12722
13269
|
"summary": "Get Role",
|
|
12723
13270
|
"description": "### Get information about the role with a specific id.\n",
|
|
@@ -12755,7 +13302,9 @@
|
|
|
12755
13302
|
"x-looker-activity-type": "non_query"
|
|
12756
13303
|
},
|
|
12757
13304
|
"delete": {
|
|
12758
|
-
"tags": [
|
|
13305
|
+
"tags": [
|
|
13306
|
+
"Role"
|
|
13307
|
+
],
|
|
12759
13308
|
"operationId": "delete_role",
|
|
12760
13309
|
"summary": "Delete Role",
|
|
12761
13310
|
"description": "### Delete the role with a specific id.\n",
|
|
@@ -12805,7 +13354,9 @@
|
|
|
12805
13354
|
"x-looker-activity-type": "non_query"
|
|
12806
13355
|
},
|
|
12807
13356
|
"patch": {
|
|
12808
|
-
"tags": [
|
|
13357
|
+
"tags": [
|
|
13358
|
+
"Role"
|
|
13359
|
+
],
|
|
12809
13360
|
"operationId": "update_role",
|
|
12810
13361
|
"summary": "Update Role",
|
|
12811
13362
|
"description": "### Update information about the role with a specific id.\n",
|
|
@@ -12872,7 +13423,9 @@
|
|
|
12872
13423
|
},
|
|
12873
13424
|
"/roles/{role_id}/groups": {
|
|
12874
13425
|
"get": {
|
|
12875
|
-
"tags": [
|
|
13426
|
+
"tags": [
|
|
13427
|
+
"Role"
|
|
13428
|
+
],
|
|
12876
13429
|
"operationId": "role_groups",
|
|
12877
13430
|
"summary": "Get Role Groups",
|
|
12878
13431
|
"description": "### Get information about all the groups with the role that has a specific id.\n",
|
|
@@ -12920,7 +13473,9 @@
|
|
|
12920
13473
|
"x-looker-activity-type": "non_query"
|
|
12921
13474
|
},
|
|
12922
13475
|
"put": {
|
|
12923
|
-
"tags": [
|
|
13476
|
+
"tags": [
|
|
13477
|
+
"Role"
|
|
13478
|
+
],
|
|
12924
13479
|
"operationId": "set_role_groups",
|
|
12925
13480
|
"summary": "Update Role Groups",
|
|
12926
13481
|
"description": "### Set all groups for a role, removing all existing group associations from that role.\n",
|
|
@@ -12988,7 +13543,9 @@
|
|
|
12988
13543
|
},
|
|
12989
13544
|
"/roles/{role_id}/users": {
|
|
12990
13545
|
"get": {
|
|
12991
|
-
"tags": [
|
|
13546
|
+
"tags": [
|
|
13547
|
+
"Role"
|
|
13548
|
+
],
|
|
12992
13549
|
"operationId": "role_users",
|
|
12993
13550
|
"summary": "Get Role Users",
|
|
12994
13551
|
"description": "### Get information about all the users with the role that has a specific id.\n",
|
|
@@ -13043,7 +13600,9 @@
|
|
|
13043
13600
|
"x-looker-activity-type": "non_query"
|
|
13044
13601
|
},
|
|
13045
13602
|
"put": {
|
|
13046
|
-
"tags": [
|
|
13603
|
+
"tags": [
|
|
13604
|
+
"Role"
|
|
13605
|
+
],
|
|
13047
13606
|
"operationId": "set_role_users",
|
|
13048
13607
|
"summary": "Update Role Users",
|
|
13049
13608
|
"description": "### Set all the users of the role with a specific id.\n",
|
|
@@ -13123,7 +13682,9 @@
|
|
|
13123
13682
|
},
|
|
13124
13683
|
"/running_queries": {
|
|
13125
13684
|
"get": {
|
|
13126
|
-
"tags": [
|
|
13685
|
+
"tags": [
|
|
13686
|
+
"Query"
|
|
13687
|
+
],
|
|
13127
13688
|
"operationId": "all_running_queries",
|
|
13128
13689
|
"summary": "Get All Running Queries",
|
|
13129
13690
|
"description": "Get information about all running queries.\n",
|
|
@@ -13150,7 +13711,9 @@
|
|
|
13150
13711
|
},
|
|
13151
13712
|
"/running_queries/{query_task_id}": {
|
|
13152
13713
|
"delete": {
|
|
13153
|
-
"tags": [
|
|
13714
|
+
"tags": [
|
|
13715
|
+
"Query"
|
|
13716
|
+
],
|
|
13154
13717
|
"operationId": "kill_query",
|
|
13155
13718
|
"summary": "Kill Running Query",
|
|
13156
13719
|
"description": "Kill a query with a specific query_task_id.\n",
|
|
@@ -13195,7 +13758,9 @@
|
|
|
13195
13758
|
},
|
|
13196
13759
|
"/saml_config": {
|
|
13197
13760
|
"get": {
|
|
13198
|
-
"tags": [
|
|
13761
|
+
"tags": [
|
|
13762
|
+
"Auth"
|
|
13763
|
+
],
|
|
13199
13764
|
"operationId": "saml_config",
|
|
13200
13765
|
"summary": "Get SAML Configuration",
|
|
13201
13766
|
"description": "### Get the SAML configuration.\n\nLooker can be optionally configured to authenticate users against a SAML authentication server.\nSAML setup requires coordination with an administrator of that server.\n\nOnly Looker administrators can read and update the SAML configuration.\n\nConfiguring SAML impacts authentication for all users. This configuration should be done carefully.\n\nLooker maintains a single SAML configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct).\n\nSAML is enabled or disabled for Looker using the **enabled** field.\n",
|
|
@@ -13217,7 +13782,9 @@
|
|
|
13217
13782
|
"x-looker-activity-type": "non_query"
|
|
13218
13783
|
},
|
|
13219
13784
|
"patch": {
|
|
13220
|
-
"tags": [
|
|
13785
|
+
"tags": [
|
|
13786
|
+
"Auth"
|
|
13787
|
+
],
|
|
13221
13788
|
"operationId": "update_saml_config",
|
|
13222
13789
|
"summary": "Update SAML Configuration",
|
|
13223
13790
|
"description": "### Update the SAML configuration.\n\nConfiguring SAML impacts authentication for all users. This configuration should be done carefully.\n\nOnly Looker administrators can read and update the SAML configuration.\n\nSAML is enabled or disabled for Looker using the **enabled** field.\n\nIt is **highly** recommended that any SAML setting changes be tested using the APIs below before being set globally.\n",
|
|
@@ -13264,7 +13831,9 @@
|
|
|
13264
13831
|
},
|
|
13265
13832
|
"/saml_test_configs/{test_slug}": {
|
|
13266
13833
|
"get": {
|
|
13267
|
-
"tags": [
|
|
13834
|
+
"tags": [
|
|
13835
|
+
"Auth"
|
|
13836
|
+
],
|
|
13268
13837
|
"operationId": "saml_test_config",
|
|
13269
13838
|
"summary": "Get SAML Test Configuration",
|
|
13270
13839
|
"description": "### Get a SAML test configuration by test_slug.\n",
|
|
@@ -13295,7 +13864,9 @@
|
|
|
13295
13864
|
"x-looker-activity-type": "non_query"
|
|
13296
13865
|
},
|
|
13297
13866
|
"delete": {
|
|
13298
|
-
"tags": [
|
|
13867
|
+
"tags": [
|
|
13868
|
+
"Auth"
|
|
13869
|
+
],
|
|
13299
13870
|
"operationId": "delete_saml_test_config",
|
|
13300
13871
|
"summary": "Delete SAML Test Configuration",
|
|
13301
13872
|
"description": "### Delete a SAML test configuration.\n",
|
|
@@ -13334,7 +13905,9 @@
|
|
|
13334
13905
|
},
|
|
13335
13906
|
"/saml_test_configs": {
|
|
13336
13907
|
"post": {
|
|
13337
|
-
"tags": [
|
|
13908
|
+
"tags": [
|
|
13909
|
+
"Auth"
|
|
13910
|
+
],
|
|
13338
13911
|
"operationId": "create_saml_test_config",
|
|
13339
13912
|
"summary": "Create SAML Test Configuration",
|
|
13340
13913
|
"description": "### Create a SAML test configuration.\n",
|
|
@@ -13381,11 +13954,15 @@
|
|
|
13381
13954
|
},
|
|
13382
13955
|
"/parse_saml_idp_metadata": {
|
|
13383
13956
|
"post": {
|
|
13384
|
-
"tags": [
|
|
13957
|
+
"tags": [
|
|
13958
|
+
"Auth"
|
|
13959
|
+
],
|
|
13385
13960
|
"operationId": "parse_saml_idp_metadata",
|
|
13386
13961
|
"summary": "Parse SAML IdP XML",
|
|
13387
13962
|
"description": "### Parse the given xml as a SAML IdP metadata document and return the result.\n",
|
|
13388
|
-
"consumes": [
|
|
13963
|
+
"consumes": [
|
|
13964
|
+
"text/plain"
|
|
13965
|
+
],
|
|
13389
13966
|
"parameters": [
|
|
13390
13967
|
{
|
|
13391
13968
|
"name": "body",
|
|
@@ -13423,11 +14000,15 @@
|
|
|
13423
14000
|
},
|
|
13424
14001
|
"/fetch_and_parse_saml_idp_metadata": {
|
|
13425
14002
|
"post": {
|
|
13426
|
-
"tags": [
|
|
14003
|
+
"tags": [
|
|
14004
|
+
"Auth"
|
|
14005
|
+
],
|
|
13427
14006
|
"operationId": "fetch_and_parse_saml_idp_metadata",
|
|
13428
14007
|
"summary": "Parse SAML IdP Url",
|
|
13429
14008
|
"description": "### Fetch the given url and parse it as a SAML IdP metadata document and return the result.\nNote that this requires that the url be public or at least at a location where the Looker instance\ncan fetch it without requiring any special authentication.\n",
|
|
13430
|
-
"consumes": [
|
|
14009
|
+
"consumes": [
|
|
14010
|
+
"text/plain"
|
|
14011
|
+
],
|
|
13431
14012
|
"parameters": [
|
|
13432
14013
|
{
|
|
13433
14014
|
"name": "body",
|
|
@@ -13465,7 +14046,9 @@
|
|
|
13465
14046
|
},
|
|
13466
14047
|
"/scheduled_plans/space/{space_id}": {
|
|
13467
14048
|
"get": {
|
|
13468
|
-
"tags": [
|
|
14049
|
+
"tags": [
|
|
14050
|
+
"ScheduledPlan"
|
|
14051
|
+
],
|
|
13469
14052
|
"operationId": "scheduled_plans_for_space",
|
|
13470
14053
|
"summary": "Scheduled Plans for Space",
|
|
13471
14054
|
"description": "### Get Scheduled Plans for a Space\n\nReturns scheduled plans owned by the caller for a given space id.\n",
|
|
@@ -13515,7 +14098,9 @@
|
|
|
13515
14098
|
},
|
|
13516
14099
|
"/scheduled_plans/{scheduled_plan_id}": {
|
|
13517
14100
|
"delete": {
|
|
13518
|
-
"tags": [
|
|
14101
|
+
"tags": [
|
|
14102
|
+
"ScheduledPlan"
|
|
14103
|
+
],
|
|
13519
14104
|
"operationId": "delete_scheduled_plan",
|
|
13520
14105
|
"summary": "Delete Scheduled Plan",
|
|
13521
14106
|
"description": "### Delete a Scheduled Plan\n\nNormal users can only delete their own scheduled plans.\nAdmins can delete other users' scheduled plans.\nThis delete cannot be undone.\n",
|
|
@@ -13559,7 +14144,9 @@
|
|
|
13559
14144
|
"x-looker-activity-type": "db_query"
|
|
13560
14145
|
},
|
|
13561
14146
|
"patch": {
|
|
13562
|
-
"tags": [
|
|
14147
|
+
"tags": [
|
|
14148
|
+
"ScheduledPlan"
|
|
14149
|
+
],
|
|
13563
14150
|
"operationId": "update_scheduled_plan",
|
|
13564
14151
|
"summary": "Update Scheduled Plan",
|
|
13565
14152
|
"description": "### Update a Scheduled Plan\n\nAdmins can update other users' Scheduled Plans.\n\nNote: Any scheduled plan destinations specified in an update will **replace** all scheduled plan destinations\ncurrently defined for the scheduled plan.\n\nFor Example: If a scheduled plan has destinations A, B, and C, and you call update on this scheduled plan\nspecifying only B in the destinations, then destinations A and C will be deleted by the update.\n\nUpdating a scheduled plan to assign null or an empty array to the scheduled_plan_destinations property is an error, as a scheduled plan must always have at least one destination.\n\nIf you omit the scheduled_plan_destinations property from the object passed to update, then the destinations\ndefined on the original scheduled plan will remain unchanged.\n\n#### Email Permissions:\n\nFor details about permissions required to schedule delivery to email and the safeguards\nLooker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions).\n\n\n#### Scheduled Plan Destination Formats\n\nScheduled plan destinations must specify the data format to produce and send to the destination.\n\nFormats:\n\n| format | Description\n| :-----------: | :--- |\n| json | A JSON object containing a `data` property which contains an array of JSON objects, one per row. No metadata.\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| inline_json | Same as the JSON format, except that the `data` property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn't have to re-encode the JSON row data in order to pass it on to its ultimate destination.\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| xlsx | MS Excel spreadsheet\n| wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document\n| assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document\n| wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image\n||\n\nValid formats vary by destination type and source object. `wysiwyg_pdf` is only valid for dashboards, for example.\n\n\n",
|
|
@@ -13618,7 +14205,9 @@
|
|
|
13618
14205
|
"x-looker-activity-type": "db_query"
|
|
13619
14206
|
},
|
|
13620
14207
|
"get": {
|
|
13621
|
-
"tags": [
|
|
14208
|
+
"tags": [
|
|
14209
|
+
"ScheduledPlan"
|
|
14210
|
+
],
|
|
13622
14211
|
"operationId": "scheduled_plan",
|
|
13623
14212
|
"summary": "Get Scheduled Plan",
|
|
13624
14213
|
"description": "### Get Information About a Scheduled Plan\n\nAdmins can fetch information about other users' Scheduled Plans.\n",
|
|
@@ -13665,7 +14254,9 @@
|
|
|
13665
14254
|
},
|
|
13666
14255
|
"/scheduled_plans": {
|
|
13667
14256
|
"post": {
|
|
13668
|
-
"tags": [
|
|
14257
|
+
"tags": [
|
|
14258
|
+
"ScheduledPlan"
|
|
14259
|
+
],
|
|
13669
14260
|
"operationId": "create_scheduled_plan",
|
|
13670
14261
|
"summary": "Create Scheduled Plan",
|
|
13671
14262
|
"description": "### Create a Scheduled Plan\n\nCreate a scheduled plan to render a Look or Dashboard on a recurring schedule.\n\nTo create a scheduled plan, you MUST provide values for the following fields:\n`name`\nand\n`look_id`, `dashboard_id`, `lookml_dashboard_id`, or `query_id`\nand\n`cron_tab` or `datagroup`\nand\nat least one scheduled_plan_destination\n\nA scheduled plan MUST have at least one scheduled_plan_destination defined.\n\nWhen `look_id` is set, `require_no_results`, `require_results`, and `require_change` are all required.\n\nIf `create_scheduled_plan` fails with a 422 error, be sure to look at the error messages in the response which will explain exactly what fields are missing or values that are incompatible.\n\nThe queries that provide the data for the look or dashboard are run in the context of user account that owns the scheduled plan.\n\nWhen `run_as_recipient` is `false` or not specified, the queries that provide the data for the\nlook or dashboard are run in the context of user account that owns the scheduled plan.\n\nWhen `run_as_recipient` is `true` and all the email recipients are Looker user accounts, the\nqueries are run in the context of each recipient, so different recipients may see different\ndata from the same scheduled render of a look or dashboard. For more details, see [Run As Recipient](https://looker.com/docs/r/admin/run-as-recipient).\n\nAdmins can create and modify scheduled plans on behalf of other users by specifying a user id.\nNon-admin users may not create or modify scheduled plans by or for other users.\n\n#### Email Permissions:\n\nFor details about permissions required to schedule delivery to email and the safeguards\nLooker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions).\n\n\n#### Scheduled Plan Destination Formats\n\nScheduled plan destinations must specify the data format to produce and send to the destination.\n\nFormats:\n\n| format | Description\n| :-----------: | :--- |\n| json | A JSON object containing a `data` property which contains an array of JSON objects, one per row. No metadata.\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| inline_json | Same as the JSON format, except that the `data` property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn't have to re-encode the JSON row data in order to pass it on to its ultimate destination.\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| xlsx | MS Excel spreadsheet\n| wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document\n| assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document\n| wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image\n||\n\nValid formats vary by destination type and source object. `wysiwyg_pdf` is only valid for dashboards, for example.\n\n\n",
|
|
@@ -13722,7 +14313,9 @@
|
|
|
13722
14313
|
"x-looker-activity-type": "db_query"
|
|
13723
14314
|
},
|
|
13724
14315
|
"get": {
|
|
13725
|
-
"tags": [
|
|
14316
|
+
"tags": [
|
|
14317
|
+
"ScheduledPlan"
|
|
14318
|
+
],
|
|
13726
14319
|
"operationId": "all_scheduled_plans",
|
|
13727
14320
|
"summary": "Get All Scheduled Plans",
|
|
13728
14321
|
"description": "### List All Scheduled Plans\n\nReturns all scheduled plans which belong to the caller or given user.\n\nIf no user_id is provided, this function returns the scheduled plans owned by the caller.\n\n\nTo list all schedules for all users, pass `all_users=true`.\n\n\nThe caller must have `see_schedules` permission to see other users' scheduled plans.\n\n\n",
|
|
@@ -13785,7 +14378,9 @@
|
|
|
13785
14378
|
},
|
|
13786
14379
|
"/scheduled_plans/run_once": {
|
|
13787
14380
|
"post": {
|
|
13788
|
-
"tags": [
|
|
14381
|
+
"tags": [
|
|
14382
|
+
"ScheduledPlan"
|
|
14383
|
+
],
|
|
13789
14384
|
"operationId": "scheduled_plan_run_once",
|
|
13790
14385
|
"summary": "Run Scheduled Plan Once",
|
|
13791
14386
|
"description": "### Run a Scheduled Plan Immediately\n\nCreate a scheduled plan that runs only once, and immediately.\n\nThis can be useful for testing a Scheduled Plan before committing to a production schedule.\n\nAdmins can create scheduled plans on behalf of other users by specifying a user id.\n\nThis API is rate limited to prevent it from being used for relay spam or DoS attacks\n\n#### Email Permissions:\n\nFor details about permissions required to schedule delivery to email and the safeguards\nLooker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions).\n\n\n#### Scheduled Plan Destination Formats\n\nScheduled plan destinations must specify the data format to produce and send to the destination.\n\nFormats:\n\n| format | Description\n| :-----------: | :--- |\n| json | A JSON object containing a `data` property which contains an array of JSON objects, one per row. No metadata.\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| inline_json | Same as the JSON format, except that the `data` property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn't have to re-encode the JSON row data in order to pass it on to its ultimate destination.\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| xlsx | MS Excel spreadsheet\n| wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document\n| assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document\n| wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image\n||\n\nValid formats vary by destination type and source object. `wysiwyg_pdf` is only valid for dashboards, for example.\n\n\n",
|
|
@@ -13845,7 +14440,9 @@
|
|
|
13845
14440
|
},
|
|
13846
14441
|
"/scheduled_plans/look/{look_id}": {
|
|
13847
14442
|
"get": {
|
|
13848
|
-
"tags": [
|
|
14443
|
+
"tags": [
|
|
14444
|
+
"ScheduledPlan"
|
|
14445
|
+
],
|
|
13849
14446
|
"operationId": "scheduled_plans_for_look",
|
|
13850
14447
|
"summary": "Scheduled Plans for Look",
|
|
13851
14448
|
"description": "### Get Scheduled Plans for a Look\n\nReturns all scheduled plans for a look which belong to the caller or given user.\n\nIf no user_id is provided, this function returns the scheduled plans owned by the caller.\n\n\nTo list all schedules for all users, pass `all_users=true`.\n\n\nThe caller must have `see_schedules` permission to see other users' scheduled plans.\n\n\n",
|
|
@@ -13910,7 +14507,9 @@
|
|
|
13910
14507
|
},
|
|
13911
14508
|
"/scheduled_plans/dashboard/{dashboard_id}": {
|
|
13912
14509
|
"get": {
|
|
13913
|
-
"tags": [
|
|
14510
|
+
"tags": [
|
|
14511
|
+
"ScheduledPlan"
|
|
14512
|
+
],
|
|
13914
14513
|
"operationId": "scheduled_plans_for_dashboard",
|
|
13915
14514
|
"summary": "Scheduled Plans for Dashboard",
|
|
13916
14515
|
"description": "### Get Scheduled Plans for a Dashboard\n\nReturns all scheduled plans for a dashboard which belong to the caller or given user.\n\nIf no user_id is provided, this function returns the scheduled plans owned by the caller.\n\n\nTo list all schedules for all users, pass `all_users=true`.\n\n\nThe caller must have `see_schedules` permission to see other users' scheduled plans.\n\n\n",
|
|
@@ -13975,7 +14574,9 @@
|
|
|
13975
14574
|
},
|
|
13976
14575
|
"/scheduled_plans/lookml_dashboard/{lookml_dashboard_id}": {
|
|
13977
14576
|
"get": {
|
|
13978
|
-
"tags": [
|
|
14577
|
+
"tags": [
|
|
14578
|
+
"ScheduledPlan"
|
|
14579
|
+
],
|
|
13979
14580
|
"operationId": "scheduled_plans_for_lookml_dashboard",
|
|
13980
14581
|
"summary": "Scheduled Plans for LookML Dashboard",
|
|
13981
14582
|
"description": "### Get Scheduled Plans for a LookML Dashboard\n\nReturns all scheduled plans for a LookML Dashboard which belong to the caller or given user.\n\nIf no user_id is provided, this function returns the scheduled plans owned by the caller.\n\n\nTo list all schedules for all users, pass `all_users=true`.\n\n\nThe caller must have `see_schedules` permission to see other users' scheduled plans.\n\n\n",
|
|
@@ -14039,7 +14640,9 @@
|
|
|
14039
14640
|
},
|
|
14040
14641
|
"/scheduled_plans/{scheduled_plan_id}/run_once": {
|
|
14041
14642
|
"post": {
|
|
14042
|
-
"tags": [
|
|
14643
|
+
"tags": [
|
|
14644
|
+
"ScheduledPlan"
|
|
14645
|
+
],
|
|
14043
14646
|
"operationId": "scheduled_plan_run_once_by_id",
|
|
14044
14647
|
"summary": "Run Scheduled Plan Once by Id",
|
|
14045
14648
|
"description": "### Run a Scheduled Plan By Id Immediately\nThis function creates a run-once schedule plan based on an existing scheduled plan,\napplies modifications (if any) to the new scheduled plan, and runs the new schedule plan immediately.\nThis can be useful for testing modifications to an existing scheduled plan before committing to a production schedule.\n\nThis function internally performs the following operations:\n\n1. Copies the properties of the existing scheduled plan into a new scheduled plan\n2. Copies any properties passed in the JSON body of this request into the new scheduled plan (replacing the original values)\n3. Creates the new scheduled plan\n4. Runs the new scheduled plan\n\nThe original scheduled plan is not modified by this operation.\nAdmins can create, modify, and run scheduled plans on behalf of other users by specifying a user id.\nNon-admins can only create, modify, and run their own scheduled plans.\n\n#### Email Permissions:\n\nFor details about permissions required to schedule delivery to email and the safeguards\nLooker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions).\n\n\n#### Scheduled Plan Destination Formats\n\nScheduled plan destinations must specify the data format to produce and send to the destination.\n\nFormats:\n\n| format | Description\n| :-----------: | :--- |\n| json | A JSON object containing a `data` property which contains an array of JSON objects, one per row. No metadata.\n| json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query\n| inline_json | Same as the JSON format, except that the `data` property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn't have to re-encode the JSON row data in order to pass it on to its ultimate destination.\n| csv | Comma separated values with a header\n| txt | Tab separated values with a header\n| html | Simple html\n| xlsx | MS Excel spreadsheet\n| wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document\n| assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document\n| wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image\n||\n\nValid formats vary by destination type and source object. `wysiwyg_pdf` is only valid for dashboards, for example.\n\n\n\nThis API is rate limited to prevent it from being used for relay spam or DoS attacks\n\n",
|
|
@@ -14107,7 +14710,9 @@
|
|
|
14107
14710
|
},
|
|
14108
14711
|
"/session_config": {
|
|
14109
14712
|
"get": {
|
|
14110
|
-
"tags": [
|
|
14713
|
+
"tags": [
|
|
14714
|
+
"Auth"
|
|
14715
|
+
],
|
|
14111
14716
|
"operationId": "session_config",
|
|
14112
14717
|
"summary": "Get Session Config",
|
|
14113
14718
|
"description": "### Get session config.\n",
|
|
@@ -14135,7 +14740,9 @@
|
|
|
14135
14740
|
"x-looker-activity-type": "non_query"
|
|
14136
14741
|
},
|
|
14137
14742
|
"patch": {
|
|
14138
|
-
"tags": [
|
|
14743
|
+
"tags": [
|
|
14744
|
+
"Auth"
|
|
14745
|
+
],
|
|
14139
14746
|
"operationId": "update_session_config",
|
|
14140
14747
|
"summary": "Update Session Config",
|
|
14141
14748
|
"description": "### Update session config.\n",
|
|
@@ -14188,7 +14795,9 @@
|
|
|
14188
14795
|
},
|
|
14189
14796
|
"/session": {
|
|
14190
14797
|
"get": {
|
|
14191
|
-
"tags": [
|
|
14798
|
+
"tags": [
|
|
14799
|
+
"Session"
|
|
14800
|
+
],
|
|
14192
14801
|
"operationId": "session",
|
|
14193
14802
|
"summary": "Get Session",
|
|
14194
14803
|
"description": "### Get API Session\n\nReturns information about the current API session, such as which workspace is selected for the session.\n",
|
|
@@ -14216,7 +14825,9 @@
|
|
|
14216
14825
|
"x-looker-activity-type": "non_query"
|
|
14217
14826
|
},
|
|
14218
14827
|
"patch": {
|
|
14219
|
-
"tags": [
|
|
14828
|
+
"tags": [
|
|
14829
|
+
"Session"
|
|
14830
|
+
],
|
|
14220
14831
|
"operationId": "update_session",
|
|
14221
14832
|
"summary": "Update Session",
|
|
14222
14833
|
"description": "### Update API Session\n\n#### API Session Workspace\n\nYou can use this endpoint to change the active workspace for the current API session.\n\nOnly one workspace can be active in a session. The active workspace can be changed\nany number of times in a session.\n\nThe default workspace for API sessions is the \"production\" workspace.\n\nAll Looker APIs that use projects or lookml models (such as running queries) will\nuse the version of project and model files defined by this workspace for the lifetime of the\ncurrent API session or until the session workspace is changed again.\n\nAn API session has the same lifetime as the access_token used to authenticate API requests. Each successful\nAPI login generates a new access_token and a new API session.\n\nIf your Looker API client application needs to work in a dev workspace across multiple\nAPI sessions, be sure to select the dev workspace after each login.\n",
|
|
@@ -14269,7 +14880,9 @@
|
|
|
14269
14880
|
},
|
|
14270
14881
|
"/spaces/search": {
|
|
14271
14882
|
"get": {
|
|
14272
|
-
"tags": [
|
|
14883
|
+
"tags": [
|
|
14884
|
+
"Space"
|
|
14885
|
+
],
|
|
14273
14886
|
"operationId": "search_spaces",
|
|
14274
14887
|
"summary": "Search Spaces",
|
|
14275
14888
|
"description": "### Search Spaces\n\n Returns an **array of space objects** that match the given search criteria.\n\n If multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n\n The parameters `limit`, and `offset` are recommended for fetching results in page-size chunks.\n\n Get a **single space** by id with [Space](#!/Space/space)\n",
|
|
@@ -14394,7 +15007,9 @@
|
|
|
14394
15007
|
},
|
|
14395
15008
|
"/spaces/{space_id}": {
|
|
14396
15009
|
"get": {
|
|
14397
|
-
"tags": [
|
|
15010
|
+
"tags": [
|
|
15011
|
+
"Space"
|
|
15012
|
+
],
|
|
14398
15013
|
"operationId": "space",
|
|
14399
15014
|
"summary": "Get Space",
|
|
14400
15015
|
"description": "### Get information about the space with a specific id.",
|
|
@@ -14439,7 +15054,9 @@
|
|
|
14439
15054
|
"x-looker-activity-type": "non_query"
|
|
14440
15055
|
},
|
|
14441
15056
|
"delete": {
|
|
14442
|
-
"tags": [
|
|
15057
|
+
"tags": [
|
|
15058
|
+
"Space"
|
|
15059
|
+
],
|
|
14443
15060
|
"operationId": "delete_space",
|
|
14444
15061
|
"summary": "Delete Space",
|
|
14445
15062
|
"description": "### Delete the space with a specific id including any children spaces.\n**DANGER** this will delete all looks and dashboards in the space.\n",
|
|
@@ -14483,7 +15100,9 @@
|
|
|
14483
15100
|
"x-looker-activity-type": "non_query"
|
|
14484
15101
|
},
|
|
14485
15102
|
"patch": {
|
|
14486
|
-
"tags": [
|
|
15103
|
+
"tags": [
|
|
15104
|
+
"Space"
|
|
15105
|
+
],
|
|
14487
15106
|
"operationId": "update_space",
|
|
14488
15107
|
"summary": "Update Space",
|
|
14489
15108
|
"description": "### Update the space with a specific id.",
|
|
@@ -14544,7 +15163,9 @@
|
|
|
14544
15163
|
},
|
|
14545
15164
|
"/spaces": {
|
|
14546
15165
|
"get": {
|
|
14547
|
-
"tags": [
|
|
15166
|
+
"tags": [
|
|
15167
|
+
"Space"
|
|
15168
|
+
],
|
|
14548
15169
|
"operationId": "all_spaces",
|
|
14549
15170
|
"summary": "Get All Spaces",
|
|
14550
15171
|
"description": "### Get information about all spaces.\n\nIn API 3.x, this will not return empty personal spaces, unless they belong to the calling user.\nIn API 4.0+, all personal spaces will be returned.\n\n",
|
|
@@ -14585,7 +15206,9 @@
|
|
|
14585
15206
|
"x-looker-activity-type": "non_query"
|
|
14586
15207
|
},
|
|
14587
15208
|
"post": {
|
|
14588
|
-
"tags": [
|
|
15209
|
+
"tags": [
|
|
15210
|
+
"Space"
|
|
15211
|
+
],
|
|
14589
15212
|
"operationId": "create_space",
|
|
14590
15213
|
"summary": "Create Space",
|
|
14591
15214
|
"description": "### Create a space with specified information.\n\nCaller must have permission to edit the parent space and to create spaces, otherwise the request\nreturns 404 Not Found.\n",
|
|
@@ -14645,7 +15268,9 @@
|
|
|
14645
15268
|
},
|
|
14646
15269
|
"/spaces/{space_id}/children": {
|
|
14647
15270
|
"get": {
|
|
14648
|
-
"tags": [
|
|
15271
|
+
"tags": [
|
|
15272
|
+
"Space"
|
|
15273
|
+
],
|
|
14649
15274
|
"operationId": "space_children",
|
|
14650
15275
|
"summary": "Get Space Children",
|
|
14651
15276
|
"description": "### Get the children of a space.",
|
|
@@ -14718,7 +15343,9 @@
|
|
|
14718
15343
|
},
|
|
14719
15344
|
"/spaces/{space_id}/children/search": {
|
|
14720
15345
|
"get": {
|
|
14721
|
-
"tags": [
|
|
15346
|
+
"tags": [
|
|
15347
|
+
"Space"
|
|
15348
|
+
],
|
|
14722
15349
|
"operationId": "space_children_search",
|
|
14723
15350
|
"summary": "Search Space Children",
|
|
14724
15351
|
"description": "### Search the children of a space",
|
|
@@ -14782,7 +15409,9 @@
|
|
|
14782
15409
|
},
|
|
14783
15410
|
"/spaces/{space_id}/parent": {
|
|
14784
15411
|
"get": {
|
|
14785
|
-
"tags": [
|
|
15412
|
+
"tags": [
|
|
15413
|
+
"Space"
|
|
15414
|
+
],
|
|
14786
15415
|
"operationId": "space_parent",
|
|
14787
15416
|
"summary": "Get Space Parent",
|
|
14788
15417
|
"description": "### Get the parent of a space",
|
|
@@ -14829,7 +15458,9 @@
|
|
|
14829
15458
|
},
|
|
14830
15459
|
"/spaces/{space_id}/ancestors": {
|
|
14831
15460
|
"get": {
|
|
14832
|
-
"tags": [
|
|
15461
|
+
"tags": [
|
|
15462
|
+
"Space"
|
|
15463
|
+
],
|
|
14833
15464
|
"operationId": "space_ancestors",
|
|
14834
15465
|
"summary": "Get Space Ancestors",
|
|
14835
15466
|
"description": "### Get the ancestors of a space",
|
|
@@ -14879,7 +15510,9 @@
|
|
|
14879
15510
|
},
|
|
14880
15511
|
"/spaces/{space_id}/looks": {
|
|
14881
15512
|
"get": {
|
|
14882
|
-
"tags": [
|
|
15513
|
+
"tags": [
|
|
15514
|
+
"Space"
|
|
15515
|
+
],
|
|
14883
15516
|
"operationId": "space_looks",
|
|
14884
15517
|
"summary": "Get Space Looks",
|
|
14885
15518
|
"description": "### Get all looks in a space.\nIn API 3.x, this will return all looks in a space, including looks in the trash.\nIn API 4.0+, all looks in a space will be returned, excluding looks in the trash.\n",
|
|
@@ -14929,7 +15562,9 @@
|
|
|
14929
15562
|
},
|
|
14930
15563
|
"/spaces/{space_id}/dashboards": {
|
|
14931
15564
|
"get": {
|
|
14932
|
-
"tags": [
|
|
15565
|
+
"tags": [
|
|
15566
|
+
"Space"
|
|
15567
|
+
],
|
|
14933
15568
|
"operationId": "space_dashboards",
|
|
14934
15569
|
"summary": "Get Space Dashboards",
|
|
14935
15570
|
"description": "### Get the dashboards in a space",
|
|
@@ -14979,7 +15614,9 @@
|
|
|
14979
15614
|
},
|
|
14980
15615
|
"/folders/search": {
|
|
14981
15616
|
"get": {
|
|
14982
|
-
"tags": [
|
|
15617
|
+
"tags": [
|
|
15618
|
+
"Folder"
|
|
15619
|
+
],
|
|
14983
15620
|
"operationId": "search_folders",
|
|
14984
15621
|
"summary": "Search Folders",
|
|
14985
15622
|
"description": "Search for folders by creator id, parent id, name, etc",
|
|
@@ -15103,7 +15740,9 @@
|
|
|
15103
15740
|
},
|
|
15104
15741
|
"/folders/{folder_id}": {
|
|
15105
15742
|
"get": {
|
|
15106
|
-
"tags": [
|
|
15743
|
+
"tags": [
|
|
15744
|
+
"Folder"
|
|
15745
|
+
],
|
|
15107
15746
|
"operationId": "folder",
|
|
15108
15747
|
"summary": "Get Folder",
|
|
15109
15748
|
"description": "### Get information about the folder with a specific id.",
|
|
@@ -15147,7 +15786,9 @@
|
|
|
15147
15786
|
"x-looker-activity-type": "non_query"
|
|
15148
15787
|
},
|
|
15149
15788
|
"delete": {
|
|
15150
|
-
"tags": [
|
|
15789
|
+
"tags": [
|
|
15790
|
+
"Folder"
|
|
15791
|
+
],
|
|
15151
15792
|
"operationId": "delete_folder",
|
|
15152
15793
|
"summary": "Delete Folder",
|
|
15153
15794
|
"description": "### Delete the folder with a specific id including any children folders.\n**DANGER** this will delete all looks and dashboards in the folder.\n",
|
|
@@ -15190,7 +15831,9 @@
|
|
|
15190
15831
|
"x-looker-activity-type": "non_query"
|
|
15191
15832
|
},
|
|
15192
15833
|
"patch": {
|
|
15193
|
-
"tags": [
|
|
15834
|
+
"tags": [
|
|
15835
|
+
"Folder"
|
|
15836
|
+
],
|
|
15194
15837
|
"operationId": "update_folder",
|
|
15195
15838
|
"summary": "Update Folder",
|
|
15196
15839
|
"description": "### Update the folder with a specific id.",
|
|
@@ -15250,7 +15893,9 @@
|
|
|
15250
15893
|
},
|
|
15251
15894
|
"/folders": {
|
|
15252
15895
|
"get": {
|
|
15253
|
-
"tags": [
|
|
15896
|
+
"tags": [
|
|
15897
|
+
"Folder"
|
|
15898
|
+
],
|
|
15254
15899
|
"operationId": "all_folders",
|
|
15255
15900
|
"summary": "Get All Folders",
|
|
15256
15901
|
"description": "### Get information about all folders.\n\nIn API 3.x, this will not return empty personal folders, unless they belong to the calling user.\nIn API 4.0+, all personal folders will be returned.\n\n",
|
|
@@ -15290,7 +15935,9 @@
|
|
|
15290
15935
|
"x-looker-activity-type": "non_query"
|
|
15291
15936
|
},
|
|
15292
15937
|
"post": {
|
|
15293
|
-
"tags": [
|
|
15938
|
+
"tags": [
|
|
15939
|
+
"Folder"
|
|
15940
|
+
],
|
|
15294
15941
|
"operationId": "create_folder",
|
|
15295
15942
|
"summary": "Create Folder",
|
|
15296
15943
|
"description": "### Create a folder with specified information.\n\nCaller must have permission to edit the parent folder and to create folders, otherwise the request\nreturns 404 Not Found.\n",
|
|
@@ -15349,7 +15996,9 @@
|
|
|
15349
15996
|
},
|
|
15350
15997
|
"/folders/{folder_id}/children": {
|
|
15351
15998
|
"get": {
|
|
15352
|
-
"tags": [
|
|
15999
|
+
"tags": [
|
|
16000
|
+
"Folder"
|
|
16001
|
+
],
|
|
15353
16002
|
"operationId": "folder_children",
|
|
15354
16003
|
"summary": "Get Folder Children",
|
|
15355
16004
|
"description": "### Get the children of a folder.",
|
|
@@ -15421,7 +16070,9 @@
|
|
|
15421
16070
|
},
|
|
15422
16071
|
"/folders/{folder_id}/children/search": {
|
|
15423
16072
|
"get": {
|
|
15424
|
-
"tags": [
|
|
16073
|
+
"tags": [
|
|
16074
|
+
"Folder"
|
|
16075
|
+
],
|
|
15425
16076
|
"operationId": "folder_children_search",
|
|
15426
16077
|
"summary": "Search Folder Children",
|
|
15427
16078
|
"description": "### Search the children of a folder",
|
|
@@ -15484,7 +16135,9 @@
|
|
|
15484
16135
|
},
|
|
15485
16136
|
"/folders/{folder_id}/parent": {
|
|
15486
16137
|
"get": {
|
|
15487
|
-
"tags": [
|
|
16138
|
+
"tags": [
|
|
16139
|
+
"Folder"
|
|
16140
|
+
],
|
|
15488
16141
|
"operationId": "folder_parent",
|
|
15489
16142
|
"summary": "Get Folder Parent",
|
|
15490
16143
|
"description": "### Get the parent of a folder",
|
|
@@ -15530,7 +16183,9 @@
|
|
|
15530
16183
|
},
|
|
15531
16184
|
"/folders/{folder_id}/ancestors": {
|
|
15532
16185
|
"get": {
|
|
15533
|
-
"tags": [
|
|
16186
|
+
"tags": [
|
|
16187
|
+
"Folder"
|
|
16188
|
+
],
|
|
15534
16189
|
"operationId": "folder_ancestors",
|
|
15535
16190
|
"summary": "Get Folder Ancestors",
|
|
15536
16191
|
"description": "### Get the ancestors of a folder",
|
|
@@ -15579,7 +16234,9 @@
|
|
|
15579
16234
|
},
|
|
15580
16235
|
"/folders/{folder_id}/looks": {
|
|
15581
16236
|
"get": {
|
|
15582
|
-
"tags": [
|
|
16237
|
+
"tags": [
|
|
16238
|
+
"Folder"
|
|
16239
|
+
],
|
|
15583
16240
|
"operationId": "folder_looks",
|
|
15584
16241
|
"summary": "Get Folder Looks",
|
|
15585
16242
|
"description": "### Get all looks in a folder.\nIn API 3.x, this will return all looks in a folder, including looks in the trash.\nIn API 4.0+, all looks in a folder will be returned, excluding looks in the trash.\n",
|
|
@@ -15628,7 +16285,9 @@
|
|
|
15628
16285
|
},
|
|
15629
16286
|
"/folders/{folder_id}/dashboards": {
|
|
15630
16287
|
"get": {
|
|
15631
|
-
"tags": [
|
|
16288
|
+
"tags": [
|
|
16289
|
+
"Folder"
|
|
16290
|
+
],
|
|
15632
16291
|
"operationId": "folder_dashboards",
|
|
15633
16292
|
"summary": "Get Folder Dashboards",
|
|
15634
16293
|
"description": "### Get the dashboards in a folder",
|
|
@@ -15677,7 +16336,9 @@
|
|
|
15677
16336
|
},
|
|
15678
16337
|
"/sql_queries/{slug}": {
|
|
15679
16338
|
"get": {
|
|
15680
|
-
"tags": [
|
|
16339
|
+
"tags": [
|
|
16340
|
+
"Query"
|
|
16341
|
+
],
|
|
15681
16342
|
"operationId": "sql_query",
|
|
15682
16343
|
"summary": "Get SQL Runner Query",
|
|
15683
16344
|
"description": "Get a SQL Runner query.",
|
|
@@ -15716,7 +16377,9 @@
|
|
|
15716
16377
|
},
|
|
15717
16378
|
"/sql_queries": {
|
|
15718
16379
|
"post": {
|
|
15719
|
-
"tags": [
|
|
16380
|
+
"tags": [
|
|
16381
|
+
"Query"
|
|
16382
|
+
],
|
|
15720
16383
|
"operationId": "create_sql_query",
|
|
15721
16384
|
"summary": "Create SQL Runner Query",
|
|
15722
16385
|
"description": "### Create a SQL Runner Query\n\nEither the `connection_name` or `model_name` parameter MUST be provided.\n",
|
|
@@ -15775,11 +16438,18 @@
|
|
|
15775
16438
|
},
|
|
15776
16439
|
"/sql_queries/{slug}/run/{result_format}": {
|
|
15777
16440
|
"post": {
|
|
15778
|
-
"tags": [
|
|
16441
|
+
"tags": [
|
|
16442
|
+
"Query"
|
|
16443
|
+
],
|
|
15779
16444
|
"operationId": "run_sql_query",
|
|
15780
16445
|
"summary": "Run SQL Runner Query",
|
|
15781
16446
|
"description": "Execute a SQL Runner query in a given result_format.",
|
|
15782
|
-
"produces": [
|
|
16447
|
+
"produces": [
|
|
16448
|
+
"text",
|
|
16449
|
+
"application/json",
|
|
16450
|
+
"image/png",
|
|
16451
|
+
"image/jpeg"
|
|
16452
|
+
],
|
|
15783
16453
|
"parameters": [
|
|
15784
16454
|
{
|
|
15785
16455
|
"name": "slug",
|
|
@@ -15841,7 +16511,9 @@
|
|
|
15841
16511
|
},
|
|
15842
16512
|
"/themes": {
|
|
15843
16513
|
"get": {
|
|
15844
|
-
"tags": [
|
|
16514
|
+
"tags": [
|
|
16515
|
+
"Theme"
|
|
16516
|
+
],
|
|
15845
16517
|
"operationId": "all_themes",
|
|
15846
16518
|
"summary": "Get All Themes",
|
|
15847
16519
|
"description": "### Get an array of all existing themes\n\nGet a **single theme** by id with [Theme](#!/Theme/theme)\n\nThis method returns an array of all existing themes. The active time for the theme is not considered.\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -15881,7 +16553,9 @@
|
|
|
15881
16553
|
"x-looker-activity-type": "non_query"
|
|
15882
16554
|
},
|
|
15883
16555
|
"post": {
|
|
15884
|
-
"tags": [
|
|
16556
|
+
"tags": [
|
|
16557
|
+
"Theme"
|
|
16558
|
+
],
|
|
15885
16559
|
"operationId": "create_theme",
|
|
15886
16560
|
"summary": "Create Theme",
|
|
15887
16561
|
"description": "### Create a theme\n\nCreates a new theme object, returning the theme details, including the created id.\n\nIf `settings` are not specified, the default theme settings will be copied into the new theme.\n\nThe theme `name` can only contain alphanumeric characters or underscores. Theme names should not contain any confidential information, such as customer names.\n\n**Update** an existing theme with [Update Theme](#!/Theme/update_theme)\n\n**Permanently delete** an existing theme with [Delete Theme](#!/Theme/delete_theme)\n\nFor more information, see [Creating and Applying Themes](https://looker.com/docs/r/admin/themes).\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -15940,7 +16614,9 @@
|
|
|
15940
16614
|
},
|
|
15941
16615
|
"/themes/search": {
|
|
15942
16616
|
"get": {
|
|
15943
|
-
"tags": [
|
|
16617
|
+
"tags": [
|
|
16618
|
+
"Theme"
|
|
16619
|
+
],
|
|
15944
16620
|
"operationId": "search_themes",
|
|
15945
16621
|
"summary": "Search Themes",
|
|
15946
16622
|
"description": "### Search all themes for matching criteria.\n\nReturns an **array of theme objects** that match the specified search criteria.\n\n| Search Parameters | Description\n| :-------------------: | :------ |\n| `begin_at` only | Find themes active at or after `begin_at`\n| `end_at` only | Find themes active at or before `end_at`\n| both set | Find themes with an active inclusive period between `begin_at` and `end_at`\n\nNote: Range matching requires boolean AND logic.\nWhen using `begin_at` and `end_at` together, do not use `filter_or`=TRUE\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n\nGet a **single theme** by id with [Theme](#!/Theme/theme)\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16043,7 +16719,9 @@
|
|
|
16043
16719
|
},
|
|
16044
16720
|
"/themes/default": {
|
|
16045
16721
|
"get": {
|
|
16046
|
-
"tags": [
|
|
16722
|
+
"tags": [
|
|
16723
|
+
"Theme"
|
|
16724
|
+
],
|
|
16047
16725
|
"operationId": "default_theme",
|
|
16048
16726
|
"summary": "Get Default Theme",
|
|
16049
16727
|
"description": "### Get the default theme\n\nReturns the active theme object set as the default.\n\nThe **default** theme name can be set in the UI on the Admin|Theme UI page\n\nThe optional `ts` parameter can specify a different timestamp than \"now.\" If specified, it returns the default theme at the time indicated.\n",
|
|
@@ -16081,7 +16759,9 @@
|
|
|
16081
16759
|
"x-looker-activity-type": "non_query"
|
|
16082
16760
|
},
|
|
16083
16761
|
"put": {
|
|
16084
|
-
"tags": [
|
|
16762
|
+
"tags": [
|
|
16763
|
+
"Theme"
|
|
16764
|
+
],
|
|
16085
16765
|
"operationId": "set_default_theme",
|
|
16086
16766
|
"summary": "Set Default Theme",
|
|
16087
16767
|
"description": "### Set the global default theme by theme name\n\nOnly Admin users can call this function.\n\nOnly an active theme with no expiration (`end_at` not set) can be assigned as the default theme. As long as a theme has an active record with no expiration, it can be set as the default.\n\n[Create Theme](#!/Theme/create) has detailed information on rules for default and active themes\n\nReturns the new specified default theme object.\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16132,7 +16812,9 @@
|
|
|
16132
16812
|
},
|
|
16133
16813
|
"/themes/active": {
|
|
16134
16814
|
"get": {
|
|
16135
|
-
"tags": [
|
|
16815
|
+
"tags": [
|
|
16816
|
+
"Theme"
|
|
16817
|
+
],
|
|
16136
16818
|
"operationId": "active_themes",
|
|
16137
16819
|
"summary": "Get Active Themes",
|
|
16138
16820
|
"description": "### Get active themes\n\nReturns an array of active themes.\n\nIf the `name` parameter is specified, it will return an array with one theme if it's active and found.\n\nThe optional `ts` parameter can specify a different timestamp than \"now.\"\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n\n",
|
|
@@ -16189,7 +16871,9 @@
|
|
|
16189
16871
|
},
|
|
16190
16872
|
"/themes/theme_or_default": {
|
|
16191
16873
|
"get": {
|
|
16192
|
-
"tags": [
|
|
16874
|
+
"tags": [
|
|
16875
|
+
"Theme"
|
|
16876
|
+
],
|
|
16193
16877
|
"operationId": "theme_or_default",
|
|
16194
16878
|
"summary": "Get Theme or Default",
|
|
16195
16879
|
"description": "### Get the named theme if it's active. Otherwise, return the default theme\n\nThe optional `ts` parameter can specify a different timestamp than \"now.\"\nNote: API users with `show` ability can call this function\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16236,7 +16920,9 @@
|
|
|
16236
16920
|
},
|
|
16237
16921
|
"/themes/validate": {
|
|
16238
16922
|
"post": {
|
|
16239
|
-
"tags": [
|
|
16923
|
+
"tags": [
|
|
16924
|
+
"Theme"
|
|
16925
|
+
],
|
|
16240
16926
|
"operationId": "validate_theme",
|
|
16241
16927
|
"summary": "Validate Theme",
|
|
16242
16928
|
"description": "### Validate a theme with the specified information\n\nValidates all values set for the theme, returning any errors encountered, or 200 OK if valid\n\nSee [Create Theme](#!/Theme/create_theme) for constraints\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16301,7 +16987,9 @@
|
|
|
16301
16987
|
},
|
|
16302
16988
|
"/themes/{theme_id}": {
|
|
16303
16989
|
"get": {
|
|
16304
|
-
"tags": [
|
|
16990
|
+
"tags": [
|
|
16991
|
+
"Theme"
|
|
16992
|
+
],
|
|
16305
16993
|
"operationId": "theme",
|
|
16306
16994
|
"summary": "Get Theme",
|
|
16307
16995
|
"description": "### Get a theme by ID\n\nUse this to retrieve a specific theme, whether or not it's currently active.\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16345,7 +17033,9 @@
|
|
|
16345
17033
|
"x-looker-activity-type": "non_query"
|
|
16346
17034
|
},
|
|
16347
17035
|
"patch": {
|
|
16348
|
-
"tags": [
|
|
17036
|
+
"tags": [
|
|
17037
|
+
"Theme"
|
|
17038
|
+
],
|
|
16349
17039
|
"operationId": "update_theme",
|
|
16350
17040
|
"summary": "Update Theme",
|
|
16351
17041
|
"description": "### Update the theme by id.\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16403,7 +17093,9 @@
|
|
|
16403
17093
|
"x-looker-activity-type": "non_query"
|
|
16404
17094
|
},
|
|
16405
17095
|
"delete": {
|
|
16406
|
-
"tags": [
|
|
17096
|
+
"tags": [
|
|
17097
|
+
"Theme"
|
|
17098
|
+
],
|
|
16407
17099
|
"operationId": "delete_theme",
|
|
16408
17100
|
"summary": "Delete Theme",
|
|
16409
17101
|
"description": "### Delete a specific theme by id\n\nThis operation permanently deletes the identified theme from the database.\n\nBecause multiple themes can have the same name (with different activation time spans) themes can only be deleted by ID.\n\nAll IDs associated with a theme name can be retrieved by searching for the theme name with [Theme Search](#!/Theme/search).\n\n**Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or help.looker.com to update your license for this feature.\n\n",
|
|
@@ -16448,7 +17140,9 @@
|
|
|
16448
17140
|
},
|
|
16449
17141
|
"/timezones": {
|
|
16450
17142
|
"get": {
|
|
16451
|
-
"tags": [
|
|
17143
|
+
"tags": [
|
|
17144
|
+
"Config"
|
|
17145
|
+
],
|
|
16452
17146
|
"operationId": "all_timezones",
|
|
16453
17147
|
"summary": "Get All Timezones",
|
|
16454
17148
|
"description": "### Get a list of timezones that Looker supports (e.g. useful for scheduling tasks).\n",
|
|
@@ -16481,7 +17175,9 @@
|
|
|
16481
17175
|
},
|
|
16482
17176
|
"/user_attributes": {
|
|
16483
17177
|
"get": {
|
|
16484
|
-
"tags": [
|
|
17178
|
+
"tags": [
|
|
17179
|
+
"UserAttribute"
|
|
17180
|
+
],
|
|
16485
17181
|
"operationId": "all_user_attributes",
|
|
16486
17182
|
"summary": "Get All User Attributes",
|
|
16487
17183
|
"description": "### Get information about all user attributes.\n",
|
|
@@ -16528,7 +17224,9 @@
|
|
|
16528
17224
|
"x-looker-activity-type": "non_query"
|
|
16529
17225
|
},
|
|
16530
17226
|
"post": {
|
|
16531
|
-
"tags": [
|
|
17227
|
+
"tags": [
|
|
17228
|
+
"UserAttribute"
|
|
17229
|
+
],
|
|
16532
17230
|
"operationId": "create_user_attribute",
|
|
16533
17231
|
"summary": "Create User Attribute",
|
|
16534
17232
|
"description": "### Create a new user attribute\n\nPermission information for a user attribute is conveyed through the `can` and `user_can_edit` fields.\nThe `user_can_edit` field indicates whether an attribute is user-editable _anywhere_ in the application.\nThe `can` field gives more granular access information, with the `set_value` child field indicating whether\nan attribute's value can be set by [Setting the User Attribute User Value](#!/User/set_user_attribute_user_value).\n\nNote: `name` and `label` fields must be unique across all user attributes in the Looker instance.\nAttempting to create a new user attribute with a name or label that duplicates an existing\nuser attribute will fail with a 422 error.\n",
|
|
@@ -16594,7 +17292,9 @@
|
|
|
16594
17292
|
},
|
|
16595
17293
|
"/user_attributes/{user_attribute_id}": {
|
|
16596
17294
|
"get": {
|
|
16597
|
-
"tags": [
|
|
17295
|
+
"tags": [
|
|
17296
|
+
"UserAttribute"
|
|
17297
|
+
],
|
|
16598
17298
|
"operationId": "user_attribute",
|
|
16599
17299
|
"summary": "Get User Attribute",
|
|
16600
17300
|
"description": "### Get information about a user attribute.\n",
|
|
@@ -16639,7 +17339,9 @@
|
|
|
16639
17339
|
"x-looker-activity-type": "non_query"
|
|
16640
17340
|
},
|
|
16641
17341
|
"patch": {
|
|
16642
|
-
"tags": [
|
|
17342
|
+
"tags": [
|
|
17343
|
+
"UserAttribute"
|
|
17344
|
+
],
|
|
16643
17345
|
"operationId": "update_user_attribute",
|
|
16644
17346
|
"summary": "Update User Attribute",
|
|
16645
17347
|
"description": "### Update a user attribute definition.\n",
|
|
@@ -16705,7 +17407,9 @@
|
|
|
16705
17407
|
"x-looker-activity-type": "non_query"
|
|
16706
17408
|
},
|
|
16707
17409
|
"delete": {
|
|
16708
|
-
"tags": [
|
|
17410
|
+
"tags": [
|
|
17411
|
+
"UserAttribute"
|
|
17412
|
+
],
|
|
16709
17413
|
"operationId": "delete_user_attribute",
|
|
16710
17414
|
"summary": "Delete User Attribute",
|
|
16711
17415
|
"description": "### Delete a user attribute (admin only).\n",
|
|
@@ -16751,7 +17455,9 @@
|
|
|
16751
17455
|
},
|
|
16752
17456
|
"/user_attributes/{user_attribute_id}/group_values": {
|
|
16753
17457
|
"get": {
|
|
16754
|
-
"tags": [
|
|
17458
|
+
"tags": [
|
|
17459
|
+
"UserAttribute"
|
|
17460
|
+
],
|
|
16755
17461
|
"operationId": "all_user_attribute_group_values",
|
|
16756
17462
|
"summary": "Get User Attribute Group Values",
|
|
16757
17463
|
"description": "### Returns all values of a user attribute defined by user groups, in precedence order.\n\nA user may be a member of multiple groups which define different values for a given user attribute.\nThe order of group-values in the response determines precedence for selecting which group-value applies\nto a given user. For more information, see [Set User Attribute Group Values](#!/UserAttribute/set_user_attribute_group_values).\n\nResults will only include groups that the caller's user account has permission to see.\n",
|
|
@@ -16799,7 +17505,9 @@
|
|
|
16799
17505
|
"x-looker-activity-type": "non_query"
|
|
16800
17506
|
},
|
|
16801
17507
|
"post": {
|
|
16802
|
-
"tags": [
|
|
17508
|
+
"tags": [
|
|
17509
|
+
"UserAttribute"
|
|
17510
|
+
],
|
|
16803
17511
|
"operationId": "set_user_attribute_group_values",
|
|
16804
17512
|
"summary": "Set User Attribute Group Values",
|
|
16805
17513
|
"description": "### Define values for a user attribute across a set of groups, in priority order.\n\nThis function defines all values for a user attribute defined by user groups. This is a global setting, potentially affecting\nall users in the system. This function replaces any existing group value definitions for the indicated user attribute.\n\nThe value of a user attribute for a given user is determined by searching the following locations, in this order:\n\n1. the user's account settings\n2. the groups that the user is a member of\n3. the default value of the user attribute, if any\n\nThe user may be a member of multiple groups which define different values for that user attribute. The order of items in the group_values parameter\ndetermines which group takes priority for that user. Lowest array index wins.\n\nAn alternate method to indicate the selection precedence of group-values is to assign numbers to the 'rank' property of each\ngroup-value object in the array. Lowest 'rank' value wins. If you use this technique, you must assign a\nrank value to every group-value object in the array.\n\n To set a user attribute value for a single user, see [Set User Attribute User Value](#!/User/set_user_attribute_user_value).\nTo set a user attribute value for all members of a group, see [Set User Attribute Group Value](#!/Group/update_user_attribute_group_value).\n",
|
|
@@ -16872,7 +17580,9 @@
|
|
|
16872
17580
|
},
|
|
16873
17581
|
"/user_login_lockouts": {
|
|
16874
17582
|
"get": {
|
|
16875
|
-
"tags": [
|
|
17583
|
+
"tags": [
|
|
17584
|
+
"Auth"
|
|
17585
|
+
],
|
|
16876
17586
|
"operationId": "all_user_login_lockouts",
|
|
16877
17587
|
"summary": "Get All User Login Lockouts",
|
|
16878
17588
|
"description": "### Get currently locked-out users.\n",
|
|
@@ -16914,7 +17624,9 @@
|
|
|
16914
17624
|
},
|
|
16915
17625
|
"/user_login_lockouts/search": {
|
|
16916
17626
|
"get": {
|
|
16917
|
-
"tags": [
|
|
17627
|
+
"tags": [
|
|
17628
|
+
"Auth"
|
|
17629
|
+
],
|
|
16918
17630
|
"operationId": "search_user_login_lockouts",
|
|
16919
17631
|
"summary": "Search User Login Lockouts",
|
|
16920
17632
|
"description": "### Search currently locked-out users.\n",
|
|
@@ -17014,7 +17726,9 @@
|
|
|
17014
17726
|
},
|
|
17015
17727
|
"/user_login_lockout/{key}": {
|
|
17016
17728
|
"delete": {
|
|
17017
|
-
"tags": [
|
|
17729
|
+
"tags": [
|
|
17730
|
+
"Auth"
|
|
17731
|
+
],
|
|
17018
17732
|
"operationId": "delete_user_login_lockout",
|
|
17019
17733
|
"summary": "Delete User Login Lockout",
|
|
17020
17734
|
"description": "### Removes login lockout for the associated user.\n",
|
|
@@ -17059,7 +17773,9 @@
|
|
|
17059
17773
|
},
|
|
17060
17774
|
"/user": {
|
|
17061
17775
|
"get": {
|
|
17062
|
-
"tags": [
|
|
17776
|
+
"tags": [
|
|
17777
|
+
"User"
|
|
17778
|
+
],
|
|
17063
17779
|
"operationId": "me",
|
|
17064
17780
|
"summary": "Get Current User",
|
|
17065
17781
|
"description": "### Get information about the current user; i.e. the user account currently calling the API.\n",
|
|
@@ -17092,7 +17808,9 @@
|
|
|
17092
17808
|
},
|
|
17093
17809
|
"/users": {
|
|
17094
17810
|
"get": {
|
|
17095
|
-
"tags": [
|
|
17811
|
+
"tags": [
|
|
17812
|
+
"User"
|
|
17813
|
+
],
|
|
17096
17814
|
"operationId": "all_users",
|
|
17097
17815
|
"summary": "Get All Users",
|
|
17098
17816
|
"description": "### Get information about all users.\n",
|
|
@@ -17107,7 +17825,7 @@
|
|
|
17107
17825
|
{
|
|
17108
17826
|
"name": "page",
|
|
17109
17827
|
"in": "query",
|
|
17110
|
-
"description": "
|
|
17828
|
+
"description": "Return only page N of paginated results",
|
|
17111
17829
|
"required": false,
|
|
17112
17830
|
"type": "integer",
|
|
17113
17831
|
"format": "int64"
|
|
@@ -17115,7 +17833,7 @@
|
|
|
17115
17833
|
{
|
|
17116
17834
|
"name": "per_page",
|
|
17117
17835
|
"in": "query",
|
|
17118
|
-
"description": "
|
|
17836
|
+
"description": "Return N rows of data per page",
|
|
17119
17837
|
"required": false,
|
|
17120
17838
|
"type": "integer",
|
|
17121
17839
|
"format": "int64"
|
|
@@ -17167,7 +17885,9 @@
|
|
|
17167
17885
|
"x-looker-activity-type": "non_query"
|
|
17168
17886
|
},
|
|
17169
17887
|
"post": {
|
|
17170
|
-
"tags": [
|
|
17888
|
+
"tags": [
|
|
17889
|
+
"User"
|
|
17890
|
+
],
|
|
17171
17891
|
"operationId": "create_user",
|
|
17172
17892
|
"summary": "Create User",
|
|
17173
17893
|
"description": "### Create a user with the specified information.\n",
|
|
@@ -17227,7 +17947,9 @@
|
|
|
17227
17947
|
},
|
|
17228
17948
|
"/users/search": {
|
|
17229
17949
|
"get": {
|
|
17230
|
-
"tags": [
|
|
17950
|
+
"tags": [
|
|
17951
|
+
"User"
|
|
17952
|
+
],
|
|
17231
17953
|
"operationId": "search_users",
|
|
17232
17954
|
"summary": "Search Users",
|
|
17233
17955
|
"description": "### Search users\n\nReturns all<sup>*</sup> user records that match the given search criteria.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\n\n(<sup>*</sup>) Results are always filtered to the level of information the caller is permitted to view.\nLooker admins can see all user details; normal users in an open system can see\nnames of other users but no details; normal users in a closed system can only see\nnames of other users who are members of the same group as the user.\n\n",
|
|
@@ -17365,7 +18087,9 @@
|
|
|
17365
18087
|
},
|
|
17366
18088
|
"/users/search/names/{pattern}": {
|
|
17367
18089
|
"get": {
|
|
17368
|
-
"tags": [
|
|
18090
|
+
"tags": [
|
|
18091
|
+
"User"
|
|
18092
|
+
],
|
|
17369
18093
|
"operationId": "search_users_names",
|
|
17370
18094
|
"summary": "Search User Names",
|
|
17371
18095
|
"description": "### Search for user accounts by name\n\nReturns all user accounts where `first_name` OR `last_name` OR `email` field values match a pattern.\nThe pattern can contain `%` and `_` wildcards as in SQL LIKE expressions.\n\nAny additional search params will be combined into a logical AND expression.\n",
|
|
@@ -17480,7 +18204,9 @@
|
|
|
17480
18204
|
},
|
|
17481
18205
|
"/users/{user_id}": {
|
|
17482
18206
|
"get": {
|
|
17483
|
-
"tags": [
|
|
18207
|
+
"tags": [
|
|
18208
|
+
"User"
|
|
18209
|
+
],
|
|
17484
18210
|
"operationId": "user",
|
|
17485
18211
|
"summary": "Get User by Id",
|
|
17486
18212
|
"description": "### Get information about the user with a specific id.\n\nIf the caller is an admin or the caller is the user being specified, then full user information will\nbe returned. Otherwise, a minimal 'public' variant of the user information will be returned. This contains\nThe user name and avatar url, but no sensitive information.\n",
|
|
@@ -17525,7 +18251,9 @@
|
|
|
17525
18251
|
"x-looker-activity-type": "non_query"
|
|
17526
18252
|
},
|
|
17527
18253
|
"patch": {
|
|
17528
|
-
"tags": [
|
|
18254
|
+
"tags": [
|
|
18255
|
+
"User"
|
|
18256
|
+
],
|
|
17529
18257
|
"operationId": "update_user",
|
|
17530
18258
|
"summary": "Update User",
|
|
17531
18259
|
"description": "### Update information about the user with a specific id.\n",
|
|
@@ -17585,7 +18313,9 @@
|
|
|
17585
18313
|
"x-looker-activity-type": "non_query"
|
|
17586
18314
|
},
|
|
17587
18315
|
"delete": {
|
|
17588
|
-
"tags": [
|
|
18316
|
+
"tags": [
|
|
18317
|
+
"User"
|
|
18318
|
+
],
|
|
17589
18319
|
"operationId": "delete_user",
|
|
17590
18320
|
"summary": "Delete User",
|
|
17591
18321
|
"description": "### Delete the user with a specific id.\n\n**DANGER** this will delete the user and all looks and other information owned by the user.\n",
|
|
@@ -17631,7 +18361,9 @@
|
|
|
17631
18361
|
},
|
|
17632
18362
|
"/users/credential/{credential_type}/{credential_id}": {
|
|
17633
18363
|
"get": {
|
|
17634
|
-
"tags": [
|
|
18364
|
+
"tags": [
|
|
18365
|
+
"User"
|
|
18366
|
+
],
|
|
17635
18367
|
"operationId": "user_for_credential",
|
|
17636
18368
|
"summary": "Get User by Credential Id",
|
|
17637
18369
|
"description": "### Get information about the user with a credential of given type with specific id.\n\nThis is used to do things like find users by their embed external_user_id. Or, find the user with\na given api3 client_id, etc. The 'credential_type' matches the 'type' name of the various credential\ntypes. It must be one of the values listed in the table below. The 'credential_id' is your unique Id\nfor the user and is specific to each type of credential.\n\nAn example using the Ruby sdk might look like:\n\n`sdk.user_for_credential('embed', 'customer-4959425')`\n\nThis table shows the supported 'Credential Type' strings. The right column is for reference; it shows\nwhich field in the given credential type is actually searched when finding a user with the supplied\n'credential_id'.\n\n| Credential Types | Id Field Matched |\n| ---------------- | ---------------- |\n| email | email |\n| google | google_user_id |\n| saml | saml_user_id |\n| oidc | oidc_user_id |\n| ldap | ldap_id |\n| api | token |\n| api3 | client_id |\n| embed | external_user_id |\n| looker_openid | email |\n\n**NOTE**: The 'api' credential type was only used with the legacy Looker query API and is no longer supported. The credential type for API you are currently looking at is 'api3'.\n\n",
|
|
@@ -17684,7 +18416,9 @@
|
|
|
17684
18416
|
},
|
|
17685
18417
|
"/users/{user_id}/credentials_email": {
|
|
17686
18418
|
"get": {
|
|
17687
|
-
"tags": [
|
|
18419
|
+
"tags": [
|
|
18420
|
+
"User"
|
|
18421
|
+
],
|
|
17688
18422
|
"operationId": "user_credentials_email",
|
|
17689
18423
|
"summary": "Get Email/Password Credential",
|
|
17690
18424
|
"description": "### Email/password login information for the specified user.",
|
|
@@ -17729,7 +18463,9 @@
|
|
|
17729
18463
|
"x-looker-activity-type": "non_query"
|
|
17730
18464
|
},
|
|
17731
18465
|
"post": {
|
|
17732
|
-
"tags": [
|
|
18466
|
+
"tags": [
|
|
18467
|
+
"User"
|
|
18468
|
+
],
|
|
17733
18469
|
"operationId": "create_user_credentials_email",
|
|
17734
18470
|
"summary": "Create Email/Password Credential",
|
|
17735
18471
|
"description": "### Email/password login information for the specified user.",
|
|
@@ -17801,7 +18537,9 @@
|
|
|
17801
18537
|
"x-looker-activity-type": "non_query"
|
|
17802
18538
|
},
|
|
17803
18539
|
"patch": {
|
|
17804
|
-
"tags": [
|
|
18540
|
+
"tags": [
|
|
18541
|
+
"User"
|
|
18542
|
+
],
|
|
17805
18543
|
"operationId": "update_user_credentials_email",
|
|
17806
18544
|
"summary": "Update Email/Password Credential",
|
|
17807
18545
|
"description": "### Email/password login information for the specified user.",
|
|
@@ -17867,7 +18605,9 @@
|
|
|
17867
18605
|
"x-looker-activity-type": "non_query"
|
|
17868
18606
|
},
|
|
17869
18607
|
"delete": {
|
|
17870
|
-
"tags": [
|
|
18608
|
+
"tags": [
|
|
18609
|
+
"User"
|
|
18610
|
+
],
|
|
17871
18611
|
"operationId": "delete_user_credentials_email",
|
|
17872
18612
|
"summary": "Delete Email/Password Credential",
|
|
17873
18613
|
"description": "### Email/password login information for the specified user.",
|
|
@@ -17913,7 +18653,9 @@
|
|
|
17913
18653
|
},
|
|
17914
18654
|
"/users/{user_id}/credentials_totp": {
|
|
17915
18655
|
"get": {
|
|
17916
|
-
"tags": [
|
|
18656
|
+
"tags": [
|
|
18657
|
+
"User"
|
|
18658
|
+
],
|
|
17917
18659
|
"operationId": "user_credentials_totp",
|
|
17918
18660
|
"summary": "Get Two-Factor Credential",
|
|
17919
18661
|
"description": "### Two-factor login information for the specified user.",
|
|
@@ -17958,7 +18700,9 @@
|
|
|
17958
18700
|
"x-looker-activity-type": "non_query"
|
|
17959
18701
|
},
|
|
17960
18702
|
"post": {
|
|
17961
|
-
"tags": [
|
|
18703
|
+
"tags": [
|
|
18704
|
+
"User"
|
|
18705
|
+
],
|
|
17962
18706
|
"operationId": "create_user_credentials_totp",
|
|
17963
18707
|
"summary": "Create Two-Factor Credential",
|
|
17964
18708
|
"description": "### Two-factor login information for the specified user.",
|
|
@@ -18030,7 +18774,9 @@
|
|
|
18030
18774
|
"x-looker-activity-type": "non_query"
|
|
18031
18775
|
},
|
|
18032
18776
|
"delete": {
|
|
18033
|
-
"tags": [
|
|
18777
|
+
"tags": [
|
|
18778
|
+
"User"
|
|
18779
|
+
],
|
|
18034
18780
|
"operationId": "delete_user_credentials_totp",
|
|
18035
18781
|
"summary": "Delete Two-Factor Credential",
|
|
18036
18782
|
"description": "### Two-factor login information for the specified user.",
|
|
@@ -18076,7 +18822,9 @@
|
|
|
18076
18822
|
},
|
|
18077
18823
|
"/users/{user_id}/credentials_ldap": {
|
|
18078
18824
|
"get": {
|
|
18079
|
-
"tags": [
|
|
18825
|
+
"tags": [
|
|
18826
|
+
"User"
|
|
18827
|
+
],
|
|
18080
18828
|
"operationId": "user_credentials_ldap",
|
|
18081
18829
|
"summary": "Get LDAP Credential",
|
|
18082
18830
|
"description": "### LDAP login information for the specified user.",
|
|
@@ -18121,7 +18869,9 @@
|
|
|
18121
18869
|
"x-looker-activity-type": "non_query"
|
|
18122
18870
|
},
|
|
18123
18871
|
"delete": {
|
|
18124
|
-
"tags": [
|
|
18872
|
+
"tags": [
|
|
18873
|
+
"User"
|
|
18874
|
+
],
|
|
18125
18875
|
"operationId": "delete_user_credentials_ldap",
|
|
18126
18876
|
"summary": "Delete LDAP Credential",
|
|
18127
18877
|
"description": "### LDAP login information for the specified user.",
|
|
@@ -18167,7 +18917,9 @@
|
|
|
18167
18917
|
},
|
|
18168
18918
|
"/users/{user_id}/credentials_google": {
|
|
18169
18919
|
"get": {
|
|
18170
|
-
"tags": [
|
|
18920
|
+
"tags": [
|
|
18921
|
+
"User"
|
|
18922
|
+
],
|
|
18171
18923
|
"operationId": "user_credentials_google",
|
|
18172
18924
|
"summary": "Get Google Auth Credential",
|
|
18173
18925
|
"description": "### Google authentication login information for the specified user.",
|
|
@@ -18212,7 +18964,9 @@
|
|
|
18212
18964
|
"x-looker-activity-type": "non_query"
|
|
18213
18965
|
},
|
|
18214
18966
|
"delete": {
|
|
18215
|
-
"tags": [
|
|
18967
|
+
"tags": [
|
|
18968
|
+
"User"
|
|
18969
|
+
],
|
|
18216
18970
|
"operationId": "delete_user_credentials_google",
|
|
18217
18971
|
"summary": "Delete Google Auth Credential",
|
|
18218
18972
|
"description": "### Google authentication login information for the specified user.",
|
|
@@ -18258,7 +19012,9 @@
|
|
|
18258
19012
|
},
|
|
18259
19013
|
"/users/{user_id}/credentials_saml": {
|
|
18260
19014
|
"get": {
|
|
18261
|
-
"tags": [
|
|
19015
|
+
"tags": [
|
|
19016
|
+
"User"
|
|
19017
|
+
],
|
|
18262
19018
|
"operationId": "user_credentials_saml",
|
|
18263
19019
|
"summary": "Get Saml Auth Credential",
|
|
18264
19020
|
"description": "### Saml authentication login information for the specified user.",
|
|
@@ -18303,7 +19059,9 @@
|
|
|
18303
19059
|
"x-looker-activity-type": "non_query"
|
|
18304
19060
|
},
|
|
18305
19061
|
"delete": {
|
|
18306
|
-
"tags": [
|
|
19062
|
+
"tags": [
|
|
19063
|
+
"User"
|
|
19064
|
+
],
|
|
18307
19065
|
"operationId": "delete_user_credentials_saml",
|
|
18308
19066
|
"summary": "Delete Saml Auth Credential",
|
|
18309
19067
|
"description": "### Saml authentication login information for the specified user.",
|
|
@@ -18349,7 +19107,9 @@
|
|
|
18349
19107
|
},
|
|
18350
19108
|
"/users/{user_id}/credentials_oidc": {
|
|
18351
19109
|
"get": {
|
|
18352
|
-
"tags": [
|
|
19110
|
+
"tags": [
|
|
19111
|
+
"User"
|
|
19112
|
+
],
|
|
18353
19113
|
"operationId": "user_credentials_oidc",
|
|
18354
19114
|
"summary": "Get OIDC Auth Credential",
|
|
18355
19115
|
"description": "### OpenID Connect (OIDC) authentication login information for the specified user.",
|
|
@@ -18394,7 +19154,9 @@
|
|
|
18394
19154
|
"x-looker-activity-type": "non_query"
|
|
18395
19155
|
},
|
|
18396
19156
|
"delete": {
|
|
18397
|
-
"tags": [
|
|
19157
|
+
"tags": [
|
|
19158
|
+
"User"
|
|
19159
|
+
],
|
|
18398
19160
|
"operationId": "delete_user_credentials_oidc",
|
|
18399
19161
|
"summary": "Delete OIDC Auth Credential",
|
|
18400
19162
|
"description": "### OpenID Connect (OIDC) authentication login information for the specified user.",
|
|
@@ -18440,7 +19202,9 @@
|
|
|
18440
19202
|
},
|
|
18441
19203
|
"/users/{user_id}/credentials_api3/{credentials_api3_id}": {
|
|
18442
19204
|
"get": {
|
|
18443
|
-
"tags": [
|
|
19205
|
+
"tags": [
|
|
19206
|
+
"User"
|
|
19207
|
+
],
|
|
18444
19208
|
"operationId": "user_credentials_api3",
|
|
18445
19209
|
"summary": "Get API 3 Credential",
|
|
18446
19210
|
"description": "### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.",
|
|
@@ -18493,7 +19257,9 @@
|
|
|
18493
19257
|
"x-looker-activity-type": "non_query"
|
|
18494
19258
|
},
|
|
18495
19259
|
"delete": {
|
|
18496
|
-
"tags": [
|
|
19260
|
+
"tags": [
|
|
19261
|
+
"User"
|
|
19262
|
+
],
|
|
18497
19263
|
"operationId": "delete_user_credentials_api3",
|
|
18498
19264
|
"summary": "Delete API 3 Credential",
|
|
18499
19265
|
"description": "### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.",
|
|
@@ -18547,7 +19313,9 @@
|
|
|
18547
19313
|
},
|
|
18548
19314
|
"/users/{user_id}/credentials_api3": {
|
|
18549
19315
|
"get": {
|
|
18550
|
-
"tags": [
|
|
19316
|
+
"tags": [
|
|
19317
|
+
"User"
|
|
19318
|
+
],
|
|
18551
19319
|
"operationId": "all_user_credentials_api3s",
|
|
18552
19320
|
"summary": "Get All API 3 Credentials",
|
|
18553
19321
|
"description": "### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.",
|
|
@@ -18595,7 +19363,9 @@
|
|
|
18595
19363
|
"x-looker-activity-type": "non_query"
|
|
18596
19364
|
},
|
|
18597
19365
|
"post": {
|
|
18598
|
-
"tags": [
|
|
19366
|
+
"tags": [
|
|
19367
|
+
"User"
|
|
19368
|
+
],
|
|
18599
19369
|
"operationId": "create_user_credentials_api3",
|
|
18600
19370
|
"summary": "Create API 3 Credential",
|
|
18601
19371
|
"description": "### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.",
|
|
@@ -18669,7 +19439,9 @@
|
|
|
18669
19439
|
},
|
|
18670
19440
|
"/users/{user_id}/credentials_embed/{credentials_embed_id}": {
|
|
18671
19441
|
"get": {
|
|
18672
|
-
"tags": [
|
|
19442
|
+
"tags": [
|
|
19443
|
+
"User"
|
|
19444
|
+
],
|
|
18673
19445
|
"operationId": "user_credentials_embed",
|
|
18674
19446
|
"summary": "Get Embedding Credential",
|
|
18675
19447
|
"description": "### Embed login information for the specified user.",
|
|
@@ -18722,7 +19494,9 @@
|
|
|
18722
19494
|
"x-looker-activity-type": "non_query"
|
|
18723
19495
|
},
|
|
18724
19496
|
"delete": {
|
|
18725
|
-
"tags": [
|
|
19497
|
+
"tags": [
|
|
19498
|
+
"User"
|
|
19499
|
+
],
|
|
18726
19500
|
"operationId": "delete_user_credentials_embed",
|
|
18727
19501
|
"summary": "Delete Embedding Credential",
|
|
18728
19502
|
"description": "### Embed login information for the specified user.",
|
|
@@ -18776,7 +19550,9 @@
|
|
|
18776
19550
|
},
|
|
18777
19551
|
"/users/{user_id}/credentials_embed": {
|
|
18778
19552
|
"get": {
|
|
18779
|
-
"tags": [
|
|
19553
|
+
"tags": [
|
|
19554
|
+
"User"
|
|
19555
|
+
],
|
|
18780
19556
|
"operationId": "all_user_credentials_embeds",
|
|
18781
19557
|
"summary": "Get All Embedding Credentials",
|
|
18782
19558
|
"description": "### Embed login information for the specified user.",
|
|
@@ -18826,7 +19602,9 @@
|
|
|
18826
19602
|
},
|
|
18827
19603
|
"/users/{user_id}/credentials_looker_openid": {
|
|
18828
19604
|
"get": {
|
|
18829
|
-
"tags": [
|
|
19605
|
+
"tags": [
|
|
19606
|
+
"User"
|
|
19607
|
+
],
|
|
18830
19608
|
"operationId": "user_credentials_looker_openid",
|
|
18831
19609
|
"summary": "Get Looker OpenId Credential",
|
|
18832
19610
|
"description": "### Looker Openid login information for the specified user. Used by Looker Analysts.",
|
|
@@ -18871,7 +19649,9 @@
|
|
|
18871
19649
|
"x-looker-activity-type": "non_query"
|
|
18872
19650
|
},
|
|
18873
19651
|
"delete": {
|
|
18874
|
-
"tags": [
|
|
19652
|
+
"tags": [
|
|
19653
|
+
"User"
|
|
19654
|
+
],
|
|
18875
19655
|
"operationId": "delete_user_credentials_looker_openid",
|
|
18876
19656
|
"summary": "Delete Looker OpenId Credential",
|
|
18877
19657
|
"description": "### Looker Openid login information for the specified user. Used by Looker Analysts.",
|
|
@@ -18917,7 +19697,9 @@
|
|
|
18917
19697
|
},
|
|
18918
19698
|
"/users/{user_id}/sessions/{session_id}": {
|
|
18919
19699
|
"get": {
|
|
18920
|
-
"tags": [
|
|
19700
|
+
"tags": [
|
|
19701
|
+
"User"
|
|
19702
|
+
],
|
|
18921
19703
|
"operationId": "user_session",
|
|
18922
19704
|
"summary": "Get Web Login Session",
|
|
18923
19705
|
"description": "### Web login session for the specified user.",
|
|
@@ -18970,7 +19752,9 @@
|
|
|
18970
19752
|
"x-looker-activity-type": "non_query"
|
|
18971
19753
|
},
|
|
18972
19754
|
"delete": {
|
|
18973
|
-
"tags": [
|
|
19755
|
+
"tags": [
|
|
19756
|
+
"User"
|
|
19757
|
+
],
|
|
18974
19758
|
"operationId": "delete_user_session",
|
|
18975
19759
|
"summary": "Delete Web Login Session",
|
|
18976
19760
|
"description": "### Web login session for the specified user.",
|
|
@@ -19024,7 +19808,9 @@
|
|
|
19024
19808
|
},
|
|
19025
19809
|
"/users/{user_id}/sessions": {
|
|
19026
19810
|
"get": {
|
|
19027
|
-
"tags": [
|
|
19811
|
+
"tags": [
|
|
19812
|
+
"User"
|
|
19813
|
+
],
|
|
19028
19814
|
"operationId": "all_user_sessions",
|
|
19029
19815
|
"summary": "Get All Web Login Sessions",
|
|
19030
19816
|
"description": "### Web login session for the specified user.",
|
|
@@ -19074,7 +19860,9 @@
|
|
|
19074
19860
|
},
|
|
19075
19861
|
"/users/{user_id}/credentials_email/password_reset": {
|
|
19076
19862
|
"post": {
|
|
19077
|
-
"tags": [
|
|
19863
|
+
"tags": [
|
|
19864
|
+
"User"
|
|
19865
|
+
],
|
|
19078
19866
|
"operationId": "create_user_credentials_email_password_reset",
|
|
19079
19867
|
"summary": "Create Password Reset Token",
|
|
19080
19868
|
"description": "### Create a password reset token.\nThis will create a cryptographically secure random password reset token for the user.\nIf the user already has a password reset token then this invalidates the old token and creates a new one.\nThe token is expressed as the 'password_reset_url' of the user's email/password credential object.\nThis takes an optional 'expires' param to indicate if the new token should be an expiring token.\nTokens that expire are typically used for self-service password resets for existing users.\nInvitation emails for new users typically are not set to expire.\nThe expire period is always 60 minutes when expires is enabled.\nThis method can be called with an empty body.\n",
|
|
@@ -19128,7 +19916,9 @@
|
|
|
19128
19916
|
},
|
|
19129
19917
|
"/users/{user_id}/roles": {
|
|
19130
19918
|
"get": {
|
|
19131
|
-
"tags": [
|
|
19919
|
+
"tags": [
|
|
19920
|
+
"User"
|
|
19921
|
+
],
|
|
19132
19922
|
"operationId": "user_roles",
|
|
19133
19923
|
"summary": "Get User Roles",
|
|
19134
19924
|
"description": "### Get information about roles of a given user\n",
|
|
@@ -19183,7 +19973,9 @@
|
|
|
19183
19973
|
"x-looker-activity-type": "non_query"
|
|
19184
19974
|
},
|
|
19185
19975
|
"put": {
|
|
19186
|
-
"tags": [
|
|
19976
|
+
"tags": [
|
|
19977
|
+
"User"
|
|
19978
|
+
],
|
|
19187
19979
|
"operationId": "set_user_roles",
|
|
19188
19980
|
"summary": "Set User Roles",
|
|
19189
19981
|
"description": "### Set roles of the user with a specific id.\n",
|
|
@@ -19246,7 +20038,9 @@
|
|
|
19246
20038
|
},
|
|
19247
20039
|
"/users/{user_id}/attribute_values": {
|
|
19248
20040
|
"get": {
|
|
19249
|
-
"tags": [
|
|
20041
|
+
"tags": [
|
|
20042
|
+
"User"
|
|
20043
|
+
],
|
|
19250
20044
|
"operationId": "user_attribute_user_values",
|
|
19251
20045
|
"summary": "Get User Attribute Values",
|
|
19252
20046
|
"description": "### Get user attribute values for a given user.\n\nReturns the values of specified user attributes (or all user attributes) for a certain user.\n\nA value for each user attribute is searched for in the following locations, in this order:\n\n1. in the user's account information\n1. in groups that the user is a member of\n1. the default value of the user attribute\n\nIf more than one group has a value defined for a user attribute, the group with the lowest rank wins.\n\nThe response will only include user attributes for which values were found. Use `include_unset=true` to include\nempty records for user attributes with no value.\n\nThe value of all hidden user attributes will be blank.\n",
|
|
@@ -19316,7 +20110,9 @@
|
|
|
19316
20110
|
},
|
|
19317
20111
|
"/users/{user_id}/attribute_values/{user_attribute_id}": {
|
|
19318
20112
|
"patch": {
|
|
19319
|
-
"tags": [
|
|
20113
|
+
"tags": [
|
|
20114
|
+
"User"
|
|
20115
|
+
],
|
|
19320
20116
|
"operationId": "set_user_attribute_user_value",
|
|
19321
20117
|
"summary": "Set User Attribute User Value",
|
|
19322
20118
|
"description": "### Store a custom value for a user attribute in a user's account settings.\n\nPer-user user attribute values take precedence over group or default values.\n",
|
|
@@ -19377,7 +20173,9 @@
|
|
|
19377
20173
|
"x-looker-activity-type": "non_query"
|
|
19378
20174
|
},
|
|
19379
20175
|
"delete": {
|
|
19380
|
-
"tags": [
|
|
20176
|
+
"tags": [
|
|
20177
|
+
"User"
|
|
20178
|
+
],
|
|
19381
20179
|
"operationId": "delete_user_attribute_user_value",
|
|
19382
20180
|
"summary": "Delete User Attribute User Value",
|
|
19383
20181
|
"description": "### Delete a user attribute value from a user's account settings.\n\nAfter the user attribute value is deleted from the user's account settings, subsequent requests\nfor the user attribute value for this user will draw from the user's groups or the default\nvalue of the user attribute. See [Get User Attribute Values](#!/User/user_attribute_user_values) for more\ninformation about how user attribute values are resolved.\n",
|
|
@@ -19422,11 +20220,15 @@
|
|
|
19422
20220
|
},
|
|
19423
20221
|
"/vector_thumbnail/{type}/{resource_id}": {
|
|
19424
20222
|
"get": {
|
|
19425
|
-
"tags": [
|
|
20223
|
+
"tags": [
|
|
20224
|
+
"Content"
|
|
20225
|
+
],
|
|
19426
20226
|
"operationId": "vector_thumbnail",
|
|
19427
20227
|
"summary": "Get Vector Thumbnail",
|
|
19428
20228
|
"description": "### Get a vector image representing the contents of a dashboard or look.\n\n# DEPRECATED: Use [content_thumbnail()](#!/Content/content_thumbnail)\n\nThe returned thumbnail is an abstract representation of the contents of a dashbord or look and does not\nreflect the actual data displayed in the respective visualizations.\n",
|
|
19429
|
-
"produces": [
|
|
20229
|
+
"produces": [
|
|
20230
|
+
"image/svg+xml"
|
|
20231
|
+
],
|
|
19430
20232
|
"parameters": [
|
|
19431
20233
|
{
|
|
19432
20234
|
"name": "type",
|
|
@@ -19477,7 +20279,9 @@
|
|
|
19477
20279
|
},
|
|
19478
20280
|
"/versions": {
|
|
19479
20281
|
"get": {
|
|
19480
|
-
"tags": [
|
|
20282
|
+
"tags": [
|
|
20283
|
+
"Config"
|
|
20284
|
+
],
|
|
19481
20285
|
"operationId": "versions",
|
|
19482
20286
|
"summary": "Get ApiVersion",
|
|
19483
20287
|
"description": "### Get information about all API versions supported by this Looker instance.\n",
|
|
@@ -19516,7 +20320,9 @@
|
|
|
19516
20320
|
},
|
|
19517
20321
|
"/whitelabel_configuration": {
|
|
19518
20322
|
"get": {
|
|
19519
|
-
"tags": [
|
|
20323
|
+
"tags": [
|
|
20324
|
+
"Config"
|
|
20325
|
+
],
|
|
19520
20326
|
"operationId": "whitelabel_configuration",
|
|
19521
20327
|
"summary": "Get Whitelabel configuration",
|
|
19522
20328
|
"description": "### This feature is enabled only by special license.\n### Gets the whitelabel configuration, which includes hiding documentation links, custom favicon uploading, etc.\n",
|
|
@@ -19553,7 +20359,9 @@
|
|
|
19553
20359
|
"x-looker-activity-type": "non_query"
|
|
19554
20360
|
},
|
|
19555
20361
|
"put": {
|
|
19556
|
-
"tags": [
|
|
20362
|
+
"tags": [
|
|
20363
|
+
"Config"
|
|
20364
|
+
],
|
|
19557
20365
|
"operationId": "update_whitelabel_configuration",
|
|
19558
20366
|
"summary": "Update Whitelabel configuration",
|
|
19559
20367
|
"description": "### Update the whitelabel configuration\n",
|
|
@@ -19606,7 +20414,9 @@
|
|
|
19606
20414
|
},
|
|
19607
20415
|
"/workspaces": {
|
|
19608
20416
|
"get": {
|
|
19609
|
-
"tags": [
|
|
20417
|
+
"tags": [
|
|
20418
|
+
"Workspace"
|
|
20419
|
+
],
|
|
19610
20420
|
"operationId": "all_workspaces",
|
|
19611
20421
|
"summary": "Get All Workspaces",
|
|
19612
20422
|
"description": "### Get All Workspaces\n\nReturns all workspaces available to the calling user.\n",
|
|
@@ -19639,7 +20449,9 @@
|
|
|
19639
20449
|
},
|
|
19640
20450
|
"/workspaces/{workspace_id}": {
|
|
19641
20451
|
"get": {
|
|
19642
|
-
"tags": [
|
|
20452
|
+
"tags": [
|
|
20453
|
+
"Workspace"
|
|
20454
|
+
],
|
|
19643
20455
|
"operationId": "workspace",
|
|
19644
20456
|
"summary": "Get Workspace",
|
|
19645
20457
|
"description": "### Get A Workspace\n\nReturns information about a workspace such as the git status and selected branches\nof all projects available to the caller's user account.\n\nA workspace defines which versions of project files will be used to evaluate expressions\nand operations that use model definitions - operations such as running queries or rendering dashboards.\nEach project has its own git repository, and each project in a workspace may be configured to reference\nparticular branch or revision within their respective repositories.\n\nThere are two predefined workspaces available: \"production\" and \"dev\".\n\nThe production workspace is shared across all Looker users. Models in the production workspace are read-only.\nChanging files in production is accomplished by modifying files in a git branch and using Pull Requests\nto merge the changes from the dev branch into the production branch, and then telling\nLooker to sync with production.\n\nThe dev workspace is local to each Looker user. Changes made to project/model files in the dev workspace only affect\nthat user, and only when the dev workspace is selected as the active workspace for the API session.\n(See set_session_workspace()).\n\nThe dev workspace is NOT unique to an API session. Two applications accessing the Looker API using\nthe same user account will see the same files in the dev workspace. To avoid collisions between\nAPI clients it's best to have each client login with API3 credentials for a different user account.\n\nChanges made to files in a dev workspace are persistent across API sessions. It's a good\nidea to commit any changes you've made to the git repository, but not strictly required. Your modified files\nreside in a special user-specific directory on the Looker server and will still be there when you login in again\nlater and use update_session(workspace_id: \"dev\") to select the dev workspace for the new API session.\n",
|
|
@@ -19695,7 +20507,10 @@
|
|
|
19695
20507
|
}
|
|
19696
20508
|
},
|
|
19697
20509
|
"x-looker-status": "stable",
|
|
19698
|
-
"required": [
|
|
20510
|
+
"required": [
|
|
20511
|
+
"message",
|
|
20512
|
+
"documentation_url"
|
|
20513
|
+
]
|
|
19699
20514
|
},
|
|
19700
20515
|
"DashboardBase": {
|
|
19701
20516
|
"properties": {
|
|
@@ -19916,7 +20731,9 @@
|
|
|
19916
20731
|
}
|
|
19917
20732
|
},
|
|
19918
20733
|
"x-looker-status": "stable",
|
|
19919
|
-
"required": [
|
|
20734
|
+
"required": [
|
|
20735
|
+
"name"
|
|
20736
|
+
]
|
|
19920
20737
|
},
|
|
19921
20738
|
"CreateSpace": {
|
|
19922
20739
|
"properties": {
|
|
@@ -19932,7 +20749,10 @@
|
|
|
19932
20749
|
}
|
|
19933
20750
|
},
|
|
19934
20751
|
"x-looker-status": "stable",
|
|
19935
|
-
"required": [
|
|
20752
|
+
"required": [
|
|
20753
|
+
"name",
|
|
20754
|
+
"parent_id"
|
|
20755
|
+
]
|
|
19936
20756
|
},
|
|
19937
20757
|
"UpdateSpace": {
|
|
19938
20758
|
"properties": {
|
|
@@ -20072,7 +20892,9 @@
|
|
|
20072
20892
|
}
|
|
20073
20893
|
},
|
|
20074
20894
|
"x-looker-status": "stable",
|
|
20075
|
-
"required": [
|
|
20895
|
+
"required": [
|
|
20896
|
+
"name"
|
|
20897
|
+
]
|
|
20076
20898
|
},
|
|
20077
20899
|
"Homepage": {
|
|
20078
20900
|
"properties": {
|
|
@@ -20456,7 +21278,10 @@
|
|
|
20456
21278
|
}
|
|
20457
21279
|
},
|
|
20458
21280
|
"x-looker-status": "stable",
|
|
20459
|
-
"required": [
|
|
21281
|
+
"required": [
|
|
21282
|
+
"message",
|
|
21283
|
+
"documentation_url"
|
|
21284
|
+
]
|
|
20460
21285
|
},
|
|
20461
21286
|
"ValidationErrorDetail": {
|
|
20462
21287
|
"properties": {
|
|
@@ -20487,7 +21312,9 @@
|
|
|
20487
21312
|
}
|
|
20488
21313
|
},
|
|
20489
21314
|
"x-looker-status": "stable",
|
|
20490
|
-
"required": [
|
|
21315
|
+
"required": [
|
|
21316
|
+
"documentation_url"
|
|
21317
|
+
]
|
|
20491
21318
|
},
|
|
20492
21319
|
"AccessToken": {
|
|
20493
21320
|
"properties": {
|
|
@@ -20777,7 +21604,10 @@
|
|
|
20777
21604
|
"permission_type": {
|
|
20778
21605
|
"type": "string",
|
|
20779
21606
|
"readOnly": true,
|
|
20780
|
-
"x-looker-values": [
|
|
21607
|
+
"x-looker-values": [
|
|
21608
|
+
"view",
|
|
21609
|
+
"edit"
|
|
21610
|
+
],
|
|
20781
21611
|
"description": "Type of permission: \"view\" or \"edit\" Valid values are: \"view\", \"edit\".",
|
|
20782
21612
|
"x-looker-nullable": true
|
|
20783
21613
|
},
|
|
@@ -21019,7 +21849,9 @@
|
|
|
21019
21849
|
}
|
|
21020
21850
|
},
|
|
21021
21851
|
"x-looker-status": "stable",
|
|
21022
|
-
"required": [
|
|
21852
|
+
"required": [
|
|
21853
|
+
"name"
|
|
21854
|
+
]
|
|
21023
21855
|
},
|
|
21024
21856
|
"ContentValidationFolder": {
|
|
21025
21857
|
"properties": {
|
|
@@ -21036,7 +21868,9 @@
|
|
|
21036
21868
|
}
|
|
21037
21869
|
},
|
|
21038
21870
|
"x-looker-status": "stable",
|
|
21039
|
-
"required": [
|
|
21871
|
+
"required": [
|
|
21872
|
+
"name"
|
|
21873
|
+
]
|
|
21040
21874
|
},
|
|
21041
21875
|
"ContentValidationLook": {
|
|
21042
21876
|
"properties": {
|
|
@@ -21052,6 +21886,12 @@
|
|
|
21052
21886
|
"description": "Look Title",
|
|
21053
21887
|
"x-looker-nullable": true
|
|
21054
21888
|
},
|
|
21889
|
+
"short_url": {
|
|
21890
|
+
"type": "string",
|
|
21891
|
+
"readOnly": true,
|
|
21892
|
+
"description": "Short Url",
|
|
21893
|
+
"x-looker-nullable": true
|
|
21894
|
+
},
|
|
21055
21895
|
"folder": {
|
|
21056
21896
|
"$ref": "#/definitions/ContentValidationFolder",
|
|
21057
21897
|
"readOnly": true,
|
|
@@ -22004,12 +22844,12 @@
|
|
|
22004
22844
|
},
|
|
22005
22845
|
"subject": {
|
|
22006
22846
|
"type": "string",
|
|
22007
|
-
"description": "The text to appear in the email subject line.",
|
|
22847
|
+
"description": "The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.",
|
|
22008
22848
|
"x-looker-nullable": true
|
|
22009
22849
|
},
|
|
22010
22850
|
"header": {
|
|
22011
22851
|
"type": "string",
|
|
22012
|
-
"description": "The text to appear in the header line of the email body.",
|
|
22852
|
+
"description": "The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.",
|
|
22013
22853
|
"x-looker-nullable": true
|
|
22014
22854
|
}
|
|
22015
22855
|
},
|
|
@@ -22436,7 +23276,12 @@
|
|
|
22436
23276
|
}
|
|
22437
23277
|
},
|
|
22438
23278
|
"x-looker-status": "stable",
|
|
22439
|
-
"required": [
|
|
23279
|
+
"required": [
|
|
23280
|
+
"dashboard_id",
|
|
23281
|
+
"name",
|
|
23282
|
+
"title",
|
|
23283
|
+
"type"
|
|
23284
|
+
]
|
|
22440
23285
|
},
|
|
22441
23286
|
"DashboardLayoutComponent": {
|
|
22442
23287
|
"properties": {
|
|
@@ -22705,6 +23550,11 @@
|
|
|
22705
23550
|
"description": "Space",
|
|
22706
23551
|
"x-looker-nullable": true
|
|
22707
23552
|
},
|
|
23553
|
+
"alert_sync_with_dashboard_filter_enabled": {
|
|
23554
|
+
"type": "boolean",
|
|
23555
|
+
"description": "Enables alerts to keep in sync with dashboard filter changes",
|
|
23556
|
+
"x-looker-nullable": false
|
|
23557
|
+
},
|
|
22708
23558
|
"background_color": {
|
|
22709
23559
|
"type": "string",
|
|
22710
23560
|
"description": "Background color",
|
|
@@ -22782,6 +23632,11 @@
|
|
|
22782
23632
|
"description": "Number of times favorited",
|
|
22783
23633
|
"x-looker-nullable": true
|
|
22784
23634
|
},
|
|
23635
|
+
"filters_bar_collapsed": {
|
|
23636
|
+
"type": "boolean",
|
|
23637
|
+
"description": "Sets the default state of the filters bar to collapsed or open",
|
|
23638
|
+
"x-looker-nullable": false
|
|
23639
|
+
},
|
|
22785
23640
|
"last_accessed_at": {
|
|
22786
23641
|
"type": "string",
|
|
22787
23642
|
"format": "date-time",
|
|
@@ -22796,6 +23651,32 @@
|
|
|
22796
23651
|
"description": "Time last viewed in the Looker web UI",
|
|
22797
23652
|
"x-looker-nullable": true
|
|
22798
23653
|
},
|
|
23654
|
+
"updated_at": {
|
|
23655
|
+
"type": "string",
|
|
23656
|
+
"format": "date-time",
|
|
23657
|
+
"readOnly": true,
|
|
23658
|
+
"description": "Time that the Dashboard was most recently updated.",
|
|
23659
|
+
"x-looker-nullable": true
|
|
23660
|
+
},
|
|
23661
|
+
"last_updater_id": {
|
|
23662
|
+
"type": "integer",
|
|
23663
|
+
"format": "int64",
|
|
23664
|
+
"readOnly": true,
|
|
23665
|
+
"description": "Id of User that most recently updated the dashboard.",
|
|
23666
|
+
"x-looker-nullable": true
|
|
23667
|
+
},
|
|
23668
|
+
"last_updater_name": {
|
|
23669
|
+
"type": "string",
|
|
23670
|
+
"readOnly": true,
|
|
23671
|
+
"description": "Name of User that most recently updated the dashboard.",
|
|
23672
|
+
"x-looker-nullable": true
|
|
23673
|
+
},
|
|
23674
|
+
"user_name": {
|
|
23675
|
+
"type": "string",
|
|
23676
|
+
"readOnly": true,
|
|
23677
|
+
"description": "Name of User that created the dashboard.",
|
|
23678
|
+
"x-looker-nullable": true
|
|
23679
|
+
},
|
|
22799
23680
|
"load_configuration": {
|
|
22800
23681
|
"type": "string",
|
|
22801
23682
|
"description": "configuration option that governs how dashboard loading will happen.",
|
|
@@ -22965,7 +23846,8 @@
|
|
|
22965
23846
|
"action": {
|
|
22966
23847
|
"type": "object",
|
|
22967
23848
|
"additionalProperties": {
|
|
22968
|
-
"type": "string"
|
|
23849
|
+
"type": "string",
|
|
23850
|
+
"format": "any"
|
|
22969
23851
|
},
|
|
22970
23852
|
"description": "The JSON describing the data action. This JSON should be considered opaque and should be passed through unmodified from the query result it came from.",
|
|
22971
23853
|
"x-looker-nullable": true
|
|
@@ -23830,7 +24712,9 @@
|
|
|
23830
24712
|
}
|
|
23831
24713
|
},
|
|
23832
24714
|
"x-looker-status": "stable",
|
|
23833
|
-
"required": [
|
|
24715
|
+
"required": [
|
|
24716
|
+
"target_url"
|
|
24717
|
+
]
|
|
23834
24718
|
},
|
|
23835
24719
|
"EmbedUrlResponse": {
|
|
23836
24720
|
"properties": {
|
|
@@ -23948,7 +24832,9 @@
|
|
|
23948
24832
|
}
|
|
23949
24833
|
},
|
|
23950
24834
|
"x-looker-status": "stable",
|
|
23951
|
-
"required": [
|
|
24835
|
+
"required": [
|
|
24836
|
+
"name"
|
|
24837
|
+
]
|
|
23952
24838
|
},
|
|
23953
24839
|
"CreateFolder": {
|
|
23954
24840
|
"properties": {
|
|
@@ -23964,7 +24850,10 @@
|
|
|
23964
24850
|
}
|
|
23965
24851
|
},
|
|
23966
24852
|
"x-looker-status": "stable",
|
|
23967
|
-
"required": [
|
|
24853
|
+
"required": [
|
|
24854
|
+
"name",
|
|
24855
|
+
"parent_id"
|
|
24856
|
+
]
|
|
23968
24857
|
},
|
|
23969
24858
|
"UpdateFolder": {
|
|
23970
24859
|
"properties": {
|
|
@@ -24104,7 +24993,9 @@
|
|
|
24104
24993
|
}
|
|
24105
24994
|
},
|
|
24106
24995
|
"x-looker-status": "stable",
|
|
24107
|
-
"required": [
|
|
24996
|
+
"required": [
|
|
24997
|
+
"name"
|
|
24998
|
+
]
|
|
24108
24999
|
},
|
|
24109
25000
|
"GitBranch": {
|
|
24110
25001
|
"properties": {
|
|
@@ -24590,7 +25481,11 @@
|
|
|
24590
25481
|
"type": "string"
|
|
24591
25482
|
},
|
|
24592
25483
|
"readOnly": true,
|
|
24593
|
-
"x-looker-values": [
|
|
25484
|
+
"x-looker-values": [
|
|
25485
|
+
"cell",
|
|
25486
|
+
"query",
|
|
25487
|
+
"dashboard"
|
|
25488
|
+
],
|
|
24594
25489
|
"description": "A list of action types the integration supports. Valid values are: \"cell\", \"query\", \"dashboard\".",
|
|
24595
25490
|
"x-looker-nullable": false
|
|
24596
25491
|
},
|
|
@@ -24600,7 +25495,10 @@
|
|
|
24600
25495
|
"type": "string"
|
|
24601
25496
|
},
|
|
24602
25497
|
"readOnly": true,
|
|
24603
|
-
"x-looker-values": [
|
|
25498
|
+
"x-looker-values": [
|
|
25499
|
+
"formatted",
|
|
25500
|
+
"unformatted"
|
|
25501
|
+
],
|
|
24604
25502
|
"description": "A list of formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: \"formatted\", \"unformatted\".",
|
|
24605
25503
|
"x-looker-nullable": false
|
|
24606
25504
|
},
|
|
@@ -24610,7 +25508,10 @@
|
|
|
24610
25508
|
"type": "string"
|
|
24611
25509
|
},
|
|
24612
25510
|
"readOnly": true,
|
|
24613
|
-
"x-looker-values": [
|
|
25511
|
+
"x-looker-values": [
|
|
25512
|
+
"apply",
|
|
25513
|
+
"noapply"
|
|
25514
|
+
],
|
|
24614
25515
|
"description": "A list of visualization formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: \"apply\", \"noapply\".",
|
|
24615
25516
|
"x-looker-nullable": false
|
|
24616
25517
|
},
|
|
@@ -24620,7 +25521,10 @@
|
|
|
24620
25521
|
"type": "string"
|
|
24621
25522
|
},
|
|
24622
25523
|
"readOnly": true,
|
|
24623
|
-
"x-looker-values": [
|
|
25524
|
+
"x-looker-values": [
|
|
25525
|
+
"push",
|
|
25526
|
+
"url"
|
|
25527
|
+
],
|
|
24624
25528
|
"description": "A list of all the download mechanisms the integration supports. The order of values is not significant: Looker will select the most appropriate supported download mechanism for a given query. The integration must ensure it can handle any of the mechanisms it claims to support. If unspecified, this defaults to all download setting values. Valid values are: \"push\", \"url\".",
|
|
24625
25529
|
"x-looker-nullable": false
|
|
24626
25530
|
},
|
|
@@ -26725,7 +27629,10 @@
|
|
|
26725
27629
|
"align": {
|
|
26726
27630
|
"type": "string",
|
|
26727
27631
|
"readOnly": true,
|
|
26728
|
-
"x-looker-values": [
|
|
27632
|
+
"x-looker-values": [
|
|
27633
|
+
"left",
|
|
27634
|
+
"right"
|
|
27635
|
+
],
|
|
26729
27636
|
"description": "The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: \"left\", \"right\".",
|
|
26730
27637
|
"x-looker-nullable": false
|
|
26731
27638
|
},
|
|
@@ -26738,7 +27645,12 @@
|
|
|
26738
27645
|
"category": {
|
|
26739
27646
|
"type": "string",
|
|
26740
27647
|
"readOnly": true,
|
|
26741
|
-
"x-looker-values": [
|
|
27648
|
+
"x-looker-values": [
|
|
27649
|
+
"parameter",
|
|
27650
|
+
"filter",
|
|
27651
|
+
"measure",
|
|
27652
|
+
"dimension"
|
|
27653
|
+
],
|
|
26742
27654
|
"description": "Field category Valid values are: \"parameter\", \"filter\", \"measure\", \"dimension\".",
|
|
26743
27655
|
"x-looker-nullable": true
|
|
26744
27656
|
},
|
|
@@ -26790,7 +27702,10 @@
|
|
|
26790
27702
|
"fill_style": {
|
|
26791
27703
|
"type": "string",
|
|
26792
27704
|
"readOnly": true,
|
|
26793
|
-
"x-looker-values": [
|
|
27705
|
+
"x-looker-values": [
|
|
27706
|
+
"enumeration",
|
|
27707
|
+
"range"
|
|
27708
|
+
],
|
|
26794
27709
|
"description": "The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: \"enumeration\", \"range\".",
|
|
26795
27710
|
"x-looker-nullable": true
|
|
26796
27711
|
},
|
|
@@ -27211,7 +28126,10 @@
|
|
|
27211
28126
|
"format": {
|
|
27212
28127
|
"type": "string",
|
|
27213
28128
|
"readOnly": true,
|
|
27214
|
-
"x-looker-values": [
|
|
28129
|
+
"x-looker-values": [
|
|
28130
|
+
"topojson",
|
|
28131
|
+
"vector_tile_region"
|
|
28132
|
+
],
|
|
27215
28133
|
"description": "Specifies the data format of the region information. Valid values are: \"topojson\", \"vector_tile_region\".",
|
|
27216
28134
|
"x-looker-nullable": false
|
|
27217
28135
|
},
|
|
@@ -28321,8 +29239,7 @@
|
|
|
28321
29239
|
},
|
|
28322
29240
|
"git_application_server_http_scheme": {
|
|
28323
29241
|
"type": "string",
|
|
28324
|
-
"
|
|
28325
|
-
"description": "Scheme that is running on application server (for PRs, file browsing, etc.) Valid values are: \"http\", \"https\".",
|
|
29242
|
+
"description": "Scheme that is running on application server (for PRs, file browsing, etc.)",
|
|
28326
29243
|
"x-looker-nullable": true
|
|
28327
29244
|
},
|
|
28328
29245
|
"deploy_secret": {
|
|
@@ -28339,7 +29256,12 @@
|
|
|
28339
29256
|
},
|
|
28340
29257
|
"pull_request_mode": {
|
|
28341
29258
|
"type": "string",
|
|
28342
|
-
"x-looker-values": [
|
|
29259
|
+
"x-looker-values": [
|
|
29260
|
+
"off",
|
|
29261
|
+
"links",
|
|
29262
|
+
"recommended",
|
|
29263
|
+
"required"
|
|
29264
|
+
],
|
|
28343
29265
|
"description": "The git pull request policy for this project. Valid values are: \"off\", \"links\", \"recommended\", \"required\".",
|
|
28344
29266
|
"x-looker-nullable": false
|
|
28345
29267
|
},
|
|
@@ -28783,7 +29705,10 @@
|
|
|
28783
29705
|
}
|
|
28784
29706
|
},
|
|
28785
29707
|
"x-looker-status": "stable",
|
|
28786
|
-
"required": [
|
|
29708
|
+
"required": [
|
|
29709
|
+
"model",
|
|
29710
|
+
"view"
|
|
29711
|
+
]
|
|
28787
29712
|
},
|
|
28788
29713
|
"CreateQueryTask": {
|
|
28789
29714
|
"properties": {
|
|
@@ -28842,7 +29767,10 @@
|
|
|
28842
29767
|
}
|
|
28843
29768
|
},
|
|
28844
29769
|
"x-looker-status": "stable",
|
|
28845
|
-
"required": [
|
|
29770
|
+
"required": [
|
|
29771
|
+
"query_id",
|
|
29772
|
+
"result_format"
|
|
29773
|
+
]
|
|
28846
29774
|
},
|
|
28847
29775
|
"QueryTask": {
|
|
28848
29776
|
"properties": {
|
|
@@ -29032,6 +29960,12 @@
|
|
|
29032
29960
|
"description": "Id of query to render",
|
|
29033
29961
|
"x-looker-nullable": true
|
|
29034
29962
|
},
|
|
29963
|
+
"dashboard_element_id": {
|
|
29964
|
+
"type": "string",
|
|
29965
|
+
"readOnly": true,
|
|
29966
|
+
"description": "Id of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id",
|
|
29967
|
+
"x-looker-nullable": true
|
|
29968
|
+
},
|
|
29035
29969
|
"query_runtime": {
|
|
29036
29970
|
"type": "number",
|
|
29037
29971
|
"format": "double",
|
|
@@ -31400,6 +32334,12 @@
|
|
|
31400
32334
|
"readOnly": true,
|
|
31401
32335
|
"description": "API server base url",
|
|
31402
32336
|
"x-looker-nullable": false
|
|
32337
|
+
},
|
|
32338
|
+
"web_server_url": {
|
|
32339
|
+
"type": "string",
|
|
32340
|
+
"readOnly": true,
|
|
32341
|
+
"description": "Web server base url",
|
|
32342
|
+
"x-looker-nullable": false
|
|
31403
32343
|
}
|
|
31404
32344
|
},
|
|
31405
32345
|
"x-looker-status": "stable"
|
|
@@ -31426,15 +32366,6 @@
|
|
|
31426
32366
|
},
|
|
31427
32367
|
"WhitelabelConfiguration": {
|
|
31428
32368
|
"properties": {
|
|
31429
|
-
"can": {
|
|
31430
|
-
"type": "object",
|
|
31431
|
-
"additionalProperties": {
|
|
31432
|
-
"type": "boolean"
|
|
31433
|
-
},
|
|
31434
|
-
"readOnly": true,
|
|
31435
|
-
"description": "Operations the current user is able to perform on this object",
|
|
31436
|
-
"x-looker-nullable": false
|
|
31437
|
-
},
|
|
31438
32369
|
"id": {
|
|
31439
32370
|
"type": "integer",
|
|
31440
32371
|
"format": "int64",
|
|
@@ -31552,4 +32483,4 @@
|
|
|
31552
32483
|
"x-looker-status": "stable"
|
|
31553
32484
|
}
|
|
31554
32485
|
}
|
|
31555
|
-
}
|
|
32486
|
+
}
|