Skip to content

Latest commit

 

History

History
530 lines (391 loc) · 23.8 KB

LookApi.md

File metadata and controls

530 lines (391 loc) · 23.8 KB
Raw

Swagger\Client\LookApi

All URIs are relative to https://localhost:20000/api/3.1

Method HTTP request Description
allLooks GET /looks Get All Looks
copyLook POST /looks/{look_id}/copy Copy Look
createLook POST /looks Create Look
deleteLook DELETE /looks/{look_id} Delete Look
look GET /looks/{look_id} Get Look
moveLook PATCH /looks/{look_id}/move Move Look
runLook GET /looks/{look_id}/run/{result_format} Run Look
searchLooks GET /looks/search Search Looks
updateLook PATCH /looks/{look_id} Update Look

allLooks

\Swagger\Client\Model\Look[] allLooks($fields)

Get All Looks

Get information about all active Looks Returns an array of abbreviated Look objects describing all the looks that the caller has access to. Soft-deleted Looks are not included. Get the full details of a specific look by id with look(id) Find soft-deleted looks with search_looks()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->allLooks($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->allLooks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\Look[]

Authorization

No authorization required

HTTP request headers

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

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

copyLook

\Swagger\Client\Model\LookWithQuery copyLook($look_id, $folder_id)

Copy Look

Copy an existing look Creates a copy of an existing look, in a specified folder, and returns the copied look. look_id and folder_id are required. look_id and folder_id must already exist, and folder_id must be different from the current folder_id of the dashboard.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Look id to copy.
$folder_id = "folder_id_example"; // string | Folder id to copy to.

try {
    $result = $apiInstance->copyLook($look_id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->copyLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Look id to copy.
folder_id string Folder id to copy to. [optional]

Return type

\Swagger\Client\Model\LookWithQuery

Authorization

No authorization required

HTTP request headers

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

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

createLook

\Swagger\Client\Model\LookWithQuery createLook($body, $fields)

Create Look

Create a Look To create a look to display query data, first create the query with create_query() then assign the query's id to the query_id property in the call to create_look(). To place the look into a particular space, assign the space's id to the space_id property in the call to create_look().

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\LookWithQuery(); // \Swagger\Client\Model\LookWithQuery | Look
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createLook($body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->createLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\LookWithQuery Look
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\LookWithQuery

Authorization

No authorization required

HTTP request headers

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

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

deleteLook

string deleteLook($look_id)

Delete Look

Permanently Delete a Look This operation permanently removes a look from the Looker database. NOTE: There is no "undo" for this kind of delete. For information about soft-delete (which can be undone) see update_look().

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Id of look

try {
    $result = $apiInstance->deleteLook($look_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->deleteLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Id of look

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

look

\Swagger\Client\Model\LookWithQuery look($look_id, $fields)

Get Look

Get a Look. Returns detailed information about a Look and its associated Query.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Id of look
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->look($look_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->look: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Id of look
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\LookWithQuery

Authorization

No authorization required

HTTP request headers

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

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

moveLook

\Swagger\Client\Model\LookWithQuery moveLook($look_id, $folder_id)

Move Look

Move an existing look Moves a look to a specified folder, and returns the moved look. look_id and folder_id are required. look_id and folder_id must already exist, and folder_id must be different from the current folder_id of the dashboard.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Look id to move.
$folder_id = "folder_id_example"; // string | Folder id to move to.

try {
    $result = $apiInstance->moveLook($look_id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->moveLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Look id to move.
folder_id string Folder id to move to.

Return type

\Swagger\Client\Model\LookWithQuery

Authorization

No authorization required

HTTP request headers

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

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

runLook

string runLook($look_id, $result_format, $limit, $apply_formatting, $apply_vis, $cache, $image_width, $image_height, $generate_drill_links, $force_production, $cache_only, $path_prefix, $rebuild_pdts, $server_table_calcs)

Run Look

Run a Look Runs a given look's query and returns the results in the requested format. Supported formats: | result_format | Description | :-----------: | :--- | | json | Plain json | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | md | Simple markdown | xlsx | MS Excel spreadsheet | sql | Returns the generated SQL rather than running the query | png | A PNG image of the visualization of the query | jpg | A JPG image of the visualization of the query

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Id of look
$result_format = "result_format_example"; // string | Format of result
$limit = 789; // int | Row limit (may override the limit in the saved query).
$apply_formatting = true; // bool | Apply model-specified formatting to each result.
$apply_vis = true; // bool | Apply visualization options to results.
$cache = true; // bool | Get results from cache if available.
$image_width = 789; // int | Render width for image formats.
$image_height = 789; // int | Render height for image formats.
$generate_drill_links = true; // bool | Generate drill links (only applicable to 'json_detail' format.
$force_production = true; // bool | Force use of production models even if the user is in development mode. Note that this flag being false does not guarantee development models will be used.
$cache_only = true; // bool | Retrieve any results from cache even if the results have expired.
$path_prefix = "path_prefix_example"; // string | Prefix to use for drill links (url encoded).
$rebuild_pdts = true; // bool | Rebuild PDTS used in query.
$server_table_calcs = true; // bool | Perform table calculations on query results

try {
    $result = $apiInstance->runLook($look_id, $result_format, $limit, $apply_formatting, $apply_vis, $cache, $image_width, $image_height, $generate_drill_links, $force_production, $cache_only, $path_prefix, $rebuild_pdts, $server_table_calcs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->runLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Id of look
result_format string Format of result
limit int Row limit (may override the limit in the saved query). [optional]
apply_formatting bool Apply model-specified formatting to each result. [optional]
apply_vis bool Apply visualization options to results. [optional]
cache bool Get results from cache if available. [optional]
image_width int Render width for image formats. [optional]
image_height int Render height for image formats. [optional]
generate_drill_links bool Generate drill links (only applicable to 'json_detail' format. [optional]
force_production bool Force use of production models even if the user is in development mode. Note that this flag being false does not guarantee development models will be used. [optional]
cache_only bool Retrieve any results from cache even if the results have expired. [optional]
path_prefix string Prefix to use for drill links (url encoded). [optional]
rebuild_pdts bool Rebuild PDTS used in query. [optional]
server_table_calcs bool Perform table calculations on query results [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text, application/json, image/png, image/jpeg

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

searchLooks

\Swagger\Client\Model\Look[] searchLooks($id, $title, $description, $content_favorite_id, $folder_id, $user_id, $view_count, $deleted, $query_id, $curate, $last_viewed_at, $fields, $page, $per_page, $limit, $offset, $sorts, $filter_or)

Search Looks

Search Looks Returns an array of Look objects that match the specified search criteria. If multiple search params are given and filter_or is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If filter_or is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain % and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values. Get a single look by id with look(id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = "id_example"; // string | Match look id.
$title = "title_example"; // string | Match Look title.
$description = "description_example"; // string | Match Look description.
$content_favorite_id = "content_favorite_id_example"; // string | Select looks with a particular content favorite id
$folder_id = "folder_id_example"; // string | Select looks in a particular folder.
$user_id = "user_id_example"; // string | Select looks created by a particular user.
$view_count = "view_count_example"; // string | Select looks with particular view_count value
$deleted = true; // bool | Select soft-deleted looks
$query_id = "query_id_example"; // string | Select looks that reference a particular query by query_id
$curate = true; // bool | Exclude items that exist only in personal spaces other than the users
$last_viewed_at = "last_viewed_at_example"; // string | Select looks based on when they were last viewed
$fields = "fields_example"; // string | Requested fields.
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | One or more fields to sort results by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :updated_at, :last_updater_id, :view_count, :favorite_count, :content_favorite_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at, :query_id]
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression

try {
    $result = $apiInstance->searchLooks($id, $title, $description, $content_favorite_id, $folder_id, $user_id, $view_count, $deleted, $query_id, $curate, $last_viewed_at, $fields, $page, $per_page, $limit, $offset, $sorts, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->searchLooks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string Match look id. [optional]
title string Match Look title. [optional]
description string Match Look description. [optional]
content_favorite_id string Select looks with a particular content favorite id [optional]
folder_id string Select looks in a particular folder. [optional]
user_id string Select looks created by a particular user. [optional]
view_count string Select looks with particular view_count value [optional]
deleted bool Select soft-deleted looks [optional]
query_id string Select looks that reference a particular query by query_id [optional]
curate bool Exclude items that exist only in personal spaces other than the users [optional]
last_viewed_at string Select looks based on when they were last viewed [optional]
fields string Requested fields. [optional]
page int DEPRECATED. Use limit and offset instead. Return only page N of paginated results [optional]
per_page int DEPRECATED. Use limit and offset instead. Return N rows of data per page [optional]
limit int Number of results to return. (used with offset and takes priority over page and per_page) [optional]
offset int Number of results to skip before returning any. (used with limit and takes priority over page and per_page) [optional]
sorts string One or more fields to sort results by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :updated_at, :last_updater_id, :view_count, :favorite_count, :content_favorite_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at, :query_id] [optional]
filter_or bool Combine given search criteria in a boolean OR expression [optional]

Return type

\Swagger\Client\Model\Look[]

Authorization

No authorization required

HTTP request headers

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

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

updateLook

\Swagger\Client\Model\LookWithQuery updateLook($look_id, $body, $fields)

Update Look

Modify a Look Use this function to modify parts of a look. Property values given in a call to update_look are applied to the existing look, so there's no need to include properties whose values are not changing. It's best to specify only the properties you want to change and leave everything else out of your update_look call. Look properties marked 'read-only' will be ignored. When a user deletes a look in the Looker UI, the look data remains in the database but is marked with a deleted flag ("soft-deleted"). Soft-deleted looks can be undeleted (by an admin) if the delete was in error. To soft-delete a look via the API, use update_look() to change the look's deleted property to true. You can undelete a look by calling update_look to change the look's deleted property to false. Soft-deleted looks are excluded from the results of all_looks() and search_looks(), so they essentially disappear from view even though they still reside in the db. In API 3.1 and later, you can pass deleted: true as a parameter to search_looks() to list soft-deleted looks. NOTE: delete_look() performs a "hard delete" - the look data is removed from the Looker database and destroyed. There is no "undo" for delete_look().

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\LookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Id of look
$body = new \Swagger\Client\Model\LookWithQuery(); // \Swagger\Client\Model\LookWithQuery | Look
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateLook($look_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LookApi->updateLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Id of look
body \Swagger\Client\Model\LookWithQuery Look
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\LookWithQuery

Authorization

No authorization required

HTTP request headers

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

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