Swagger\Client\DashboardApi

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

Method	HTTP request	Description
allDashboards	GET /dashboards	Get All Dashboards
copyDashboard	POST /dashboards/{dashboard_id}/copy	Copy Dashboard
createDashboard	POST /dashboards	Create Dashboard
createDashboardElement	POST /dashboard_elements	Create DashboardElement
createDashboardFilter	POST /dashboard_filters	Create Dashboard Filter
createDashboardFromLookml	POST /dashboards/from_lookml	Create Dashboard from LookML
createDashboardLayout	POST /dashboard_layouts	Create DashboardLayout
dashboard	GET /dashboards/{dashboard_id}	Get Dashboard
dashboardAggregateTableLookml	GET /dashboards/aggregate_table_lookml/{dashboard_id}	Get Aggregate Table LookML for a dashboard
dashboardDashboardElements	GET /dashboards/{dashboard_id}/dashboard_elements	Get All DashboardElements
dashboardDashboardFilters	GET /dashboards/{dashboard_id}/dashboard_filters	Get All Dashboard Filters
dashboardDashboardLayouts	GET /dashboards/{dashboard_id}/dashboard_layouts	Get All DashboardLayouts
dashboardElement	GET /dashboard_elements/{dashboard_element_id}	Get DashboardElement
dashboardFilter	GET /dashboard_filters/{dashboard_filter_id}	Get Dashboard Filter
dashboardLayout	GET /dashboard_layouts/{dashboard_layout_id}	Get DashboardLayout
dashboardLayoutComponent	GET /dashboard_layout_components/{dashboard_layout_component_id}	Get DashboardLayoutComponent
dashboardLayoutDashboardLayoutComponents	GET /dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components	Get All DashboardLayoutComponents
dashboardLookml	GET /dashboards/lookml/{dashboard_id}	Get lookml of a UDD
deleteDashboard	DELETE /dashboards/{dashboard_id}	Delete Dashboard
deleteDashboardElement	DELETE /dashboard_elements/{dashboard_element_id}	Delete DashboardElement
deleteDashboardFilter	DELETE /dashboard_filters/{dashboard_filter_id}	Delete Dashboard Filter
deleteDashboardLayout	DELETE /dashboard_layouts/{dashboard_layout_id}	Delete DashboardLayout
importDashboardFromLookml	POST /dashboards/lookml	Import Dashboard from LookML
importLookmlDashboard	POST /dashboards/{lookml_dashboard_id}/import/{space_id}	Import LookML Dashboard
moveDashboard	PATCH /dashboards/{dashboard_id}/move	Move Dashboard
searchDashboardElements	GET /dashboard_elements/search	Search Dashboard Elements
searchDashboards	GET /dashboards/search	Search Dashboards
syncLookmlDashboard	PATCH /dashboards/{lookml_dashboard_id}/sync	Sync LookML Dashboard
updateDashboard	PATCH /dashboards/{dashboard_id}	Update Dashboard
updateDashboardElement	PATCH /dashboard_elements/{dashboard_element_id}	Update DashboardElement
updateDashboardFilter	PATCH /dashboard_filters/{dashboard_filter_id}	Update Dashboard Filter
updateDashboardLayout	PATCH /dashboard_layouts/{dashboard_layout_id}	Update DashboardLayout
updateDashboardLayoutComponent	PATCH /dashboard_layout_components/{dashboard_layout_component_id}	Update DashboardLayoutComponent

allDashboards

\Swagger\Client\Model\DashboardBase[] allDashboards($fields)

Get All Dashboards

Get information about all active dashboards. Returns an array of abbreviated dashboard objects. Dashboards marked as deleted are excluded from this list. Get the full details of a specific dashboard by id with dashboard() Find deleted dashboards with search_dashboards()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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->allDashboards($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->allDashboards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Swagger\Client\Model\DashboardBase[]

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]

copyDashboard

\Swagger\Client\Model\Dashboard copyDashboard($dashboard_id, $folder_id)

Copy Dashboard

Copy an existing dashboard Creates a copy of an existing dashboard, in a specified folder, and returns the copied dashboard. `dashboard_id` is required, `dashboard_id` and `folder_id` must already exist if specified. `folder_id` will default to the existing folder. If a dashboard with the same title already exists in the target folder, the copy will have '(copy)' or '(copy <# of copies>)' appended.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Dashboard id to copy.
$folder_id = "folder_id_example"; // string | Folder id to copy to.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Dashboard id to copy.
folder_id	string	Folder id to copy to.	[optional]

Return type

\Swagger\Client\Model\Dashboard

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]

createDashboard

\Swagger\Client\Model\Dashboard createDashboard($body)

Create Dashboard

Create a new dashboard Creates a new dashboard object and returns the details of the newly created dashboard. `Title` and `space_id` are required fields. `Space_id` must contain the id of an existing space. A dashboard's `title` must be unique within the space in which it resides. If you receive a 422 error response when creating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data. You can update an existing dashboard with update_dashboard() You can permanently delete an existing dashboard with delete_dashboard()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\Dashboard(); // \Swagger\Client\Model\Dashboard | Dashboard

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\Dashboard	Dashboard

Return type

\Swagger\Client\Model\Dashboard

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]

createDashboardElement

\Swagger\Client\Model\DashboardElement createDashboardElement($body, $fields, $apply_filters)

Create DashboardElement

Create a dashboard element on the dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\DashboardElement(); // \Swagger\Client\Model\DashboardElement | DashboardElement
$fields = "fields_example"; // string | Requested fields.
$apply_filters = true; // bool | Apply relevant filters on dashboard to this tile

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\DashboardElement	DashboardElement
fields	string	Requested fields.	[optional]
apply_filters	bool	Apply relevant filters on dashboard to this tile	[optional]

Return type

\Swagger\Client\Model\DashboardElement

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]

createDashboardFilter

\Swagger\Client\Model\DashboardFilter createDashboardFilter($body, $fields)

Create Dashboard Filter

Create a dashboard filter on the dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\CreateDashboardFilter(); // \Swagger\Client\Model\CreateDashboardFilter | Dashboard Filter
$fields = "fields_example"; // string | Requested fields

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\CreateDashboardFilter	Dashboard Filter
fields	string	Requested fields	[optional]

Return type

\Swagger\Client\Model\DashboardFilter

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]

createDashboardFromLookml

\Swagger\Client\Model\DashboardLookml createDashboardFromLookml($body)

Create Dashboard from LookML

DEPRECATED: Use import_dashboard_from_lookml()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\DashboardLookml(); // \Swagger\Client\Model\DashboardLookml | DashboardLookML

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\DashboardLookml	DashboardLookML

Return type

\Swagger\Client\Model\DashboardLookml

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]

createDashboardLayout

\Swagger\Client\Model\DashboardLayout createDashboardLayout($body, $fields)

Create DashboardLayout

Create a dashboard layout on the dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\DashboardLayout(); // \Swagger\Client\Model\DashboardLayout | DashboardLayout
$fields = "fields_example"; // string | Requested fields.

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

Parameters

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

Return type

\Swagger\Client\Model\DashboardLayout

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]

dashboard

\Swagger\Client\Model\Dashboard dashboard($dashboard_id, $fields)

Get Dashboard

Get information about a dashboard Returns the full details of the identified dashboard object Get a summary list of all active dashboards with all_dashboards() You can Search for dashboards with search_dashboards()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Dashboard

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]

dashboardAggregateTableLookml

\Swagger\Client\Model\DashboardAggregateTableLookml dashboardAggregateTableLookml($dashboard_id)

Get Aggregate Table LookML for a dashboard

Get Aggregate Table LookML for Each Query on a Dahboard Returns a JSON object that contains the dashboard id and Aggregate Table lookml

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard

Return type

\Swagger\Client\Model\DashboardAggregateTableLookml

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]

dashboardDashboardElements

\Swagger\Client\Model\DashboardElement[] dashboardDashboardElements($dashboard_id, $fields)

Get All DashboardElements

Get information about all the dashboard elements on a dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardElement[]

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]

dashboardDashboardFilters

\Swagger\Client\Model\DashboardFilter[] dashboardDashboardFilters($dashboard_id, $fields)

Get All Dashboard Filters

Get information about all the dashboard filters on a dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardFilter[]

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]

dashboardDashboardLayouts

\Swagger\Client\Model\DashboardLayout[] dashboardDashboardLayouts($dashboard_id, $fields)

Get All DashboardLayouts

Get information about all the dashboard elements on a dashboard with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayout[]

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]

dashboardElement

\Swagger\Client\Model\DashboardElement dashboardElement($dashboard_element_id, $fields)

Get DashboardElement

Get information about the dashboard element with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_element_id = "dashboard_element_id_example"; // string | Id of dashboard element
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_element_id	string	Id of dashboard element
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardElement

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]

dashboardFilter

\Swagger\Client\Model\DashboardFilter dashboardFilter($dashboard_filter_id, $fields)

Get Dashboard Filter

Get information about the dashboard filters with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_filter_id = "dashboard_filter_id_example"; // string | Id of dashboard filters
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_filter_id	string	Id of dashboard filters
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardFilter

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]

dashboardLayout

\Swagger\Client\Model\DashboardLayout dashboardLayout($dashboard_layout_id, $fields)

Get DashboardLayout

Get information about the dashboard layouts with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_id = "dashboard_layout_id_example"; // string | Id of dashboard layouts
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_layout_id	string	Id of dashboard layouts
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayout

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]

dashboardLayoutComponent

\Swagger\Client\Model\DashboardLayoutComponent dashboardLayoutComponent($dashboard_layout_component_id, $fields)

Get DashboardLayoutComponent

Get information about the dashboard elements with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_component_id = "dashboard_layout_component_id_example"; // string | Id of dashboard layout component
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_layout_component_id	string	Id of dashboard layout component
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayoutComponent

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]

dashboardLayoutDashboardLayoutComponents

\Swagger\Client\Model\DashboardLayoutComponent[] dashboardLayoutDashboardLayoutComponents($dashboard_layout_id, $fields)

Get All DashboardLayoutComponents

Get information about all the dashboard layout components for a dashboard layout with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_id = "dashboard_layout_id_example"; // string | Id of dashboard layout component
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_layout_id	string	Id of dashboard layout component
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayoutComponent[]

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]

dashboardLookml

\Swagger\Client\Model\DashboardLookml dashboardLookml($dashboard_id)

Get lookml of a UDD

Get lookml of a UDD Returns a JSON object that contains the dashboard id and the full lookml

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard

Return type

\Swagger\Client\Model\DashboardLookml

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]

deleteDashboard

string deleteDashboard($dashboard_id)

Delete Dashboard

Delete the dashboard with the specified id Permanently deletes a dashboard. (The dashboard cannot be recovered after this operation.) "Soft" delete or hide a dashboard by setting its `deleted` status to `True` with update_dashboard(). Note: When a dashboard is deleted in the UI, it is soft deleted. Use this API call to permanently remove it, if desired.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard

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]

deleteDashboardElement

string deleteDashboardElement($dashboard_element_id)

Delete DashboardElement

Delete a dashboard element with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_element_id = "dashboard_element_id_example"; // string | Id of dashboard element

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

Parameters

Name	Type	Description	Notes
dashboard_element_id	string	Id of dashboard element

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]

deleteDashboardFilter

string deleteDashboardFilter($dashboard_filter_id)

Delete Dashboard Filter

Delete a dashboard filter with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_filter_id = "dashboard_filter_id_example"; // string | Id of dashboard filter

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

Parameters

Name	Type	Description	Notes
dashboard_filter_id	string	Id of dashboard filter

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]

deleteDashboardLayout

string deleteDashboardLayout($dashboard_layout_id)

Delete DashboardLayout

Delete a dashboard layout with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_id = "dashboard_layout_id_example"; // string | Id of dashboard layout

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

Parameters

Name	Type	Description	Notes
dashboard_layout_id	string	Id of dashboard layout

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]

importDashboardFromLookml

\Swagger\Client\Model\DashboardLookml importDashboardFromLookml($body)

Import Dashboard from LookML

Creates a dashboard object based on LookML Dashboard YAML, and returns the details of the newly created dashboard. If a dashboard exists with the YAML-defined "preferred_slug", the new dashboard will overwrite it. Otherwise, a new dashboard will be created. Note that when a dashboard is overwritten, alerts will not be maintained. If a folder_id is specified: new dashboards will be placed in that folder, and overwritten dashboards will be moved to it If the folder_id isn't specified: new dashboards will be placed in the caller's personal folder, and overwritten dashboards will remain where they were LookML must contain valid LookML YAML code. It's recommended to use the LookML format returned from dashboard_lookml() as the input LookML (newlines replaced with ). Note that the created dashboard is not linked to any LookML Dashboard, i.e. sync_lookml_dashboard() will not update dashboards created by this method.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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\DashboardLookml(); // \Swagger\Client\Model\DashboardLookml | DashboardLookML

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\DashboardLookml	DashboardLookML

Return type

\Swagger\Client\Model\DashboardLookml

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]

importLookmlDashboard

\Swagger\Client\Model\Dashboard importLookmlDashboard($lookml_dashboard_id, $space_id, $body, $raw_locale)

Import LookML Dashboard

Import a LookML dashboard to a space as a UDD Creates a UDD (a dashboard which exists in the Looker database rather than as a LookML file) from the LookML dashboard and places it in the space specified. The created UDD will have a lookml_link_id which links to the original LookML dashboard. To give the imported dashboard specify a (e.g. title: "my title") in the body of your request, otherwise the imported dashboard will have the same title as the original LookML dashboard. For this operation to succeed the user must have permission to see the LookML dashboard in question, and have permission to create content in the space the dashboard is being imported to. Sync a linked UDD with sync_lookml_dashboard() Unlink a linked UDD by setting lookml_link_id to null with update_dashboard()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$lookml_dashboard_id = "lookml_dashboard_id_example"; // string | Id of LookML dashboard
$space_id = "space_id_example"; // string | Id of space to import the dashboard to
$body = new \Swagger\Client\Model\Dashboard(); // \Swagger\Client\Model\Dashboard | Dashboard
$raw_locale = true; // bool | If true, and this dashboard is localized, export it with the raw keys, not localized.

try {
    $result = $apiInstance->importLookmlDashboard($lookml_dashboard_id, $space_id, $body, $raw_locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->importLookmlDashboard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lookml_dashboard_id	string	Id of LookML dashboard
space_id	string	Id of space to import the dashboard to
body	\Swagger\Client\Model\Dashboard	Dashboard	[optional]
raw_locale	bool	If true, and this dashboard is localized, export it with the raw keys, not localized.	[optional]

Return type

\Swagger\Client\Model\Dashboard

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]

moveDashboard

\Swagger\Client\Model\Dashboard moveDashboard($dashboard_id, $folder_id)

Move Dashboard

Move an existing dashboard Moves a dashboard to a specified folder, and returns the moved dashboard. `dashboard_id` and `folder_id` are required. `dashboard_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\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Dashboard id to move.
$folder_id = "folder_id_example"; // string | Folder id to move to.

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Dashboard id to move.
folder_id	string	Folder id to move to.

Return type

\Swagger\Client\Model\Dashboard

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]

searchDashboardElements

\Swagger\Client\Model\DashboardElement[] searchDashboardElements($dashboard_id, $look_id, $title, $deleted, $fields, $filter_or, $sorts)

Search Dashboard Elements

Search Dashboard Elements Returns an array of DashboardElement 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.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Select elements that refer to a given dashboard id
$look_id = "look_id_example"; // string | Select elements that refer to a given look id
$title = "title_example"; // string | Match the title of element
$deleted = true; // bool | Select soft-deleted dashboard elements
$fields = "fields_example"; // string | Requested fields.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression
$sorts = "sorts_example"; // string | Fields to sort by. Sortable fields: [:look_id, :dashboard_id, :deleted, :title]

try {
    $result = $apiInstance->searchDashboardElements($dashboard_id, $look_id, $title, $deleted, $fields, $filter_or, $sorts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->searchDashboardElements: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
dashboard_id	string	Select elements that refer to a given dashboard id	[optional]
look_id	string	Select elements that refer to a given look id	[optional]
title	string	Match the title of element	[optional]
deleted	bool	Select soft-deleted dashboard elements	[optional]
fields	string	Requested fields.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]
sorts	string	Fields to sort by. Sortable fields: [:look_id, :dashboard_id, :deleted, :title]	[optional]

Return type

\Swagger\Client\Model\DashboardElement[]

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]

searchDashboards

\Swagger\Client\Model\Dashboard[] searchDashboards($id, $slug, $title, $description, $content_favorite_id, $folder_id, $deleted, $user_id, $view_count, $content_metadata_id, $curate, $last_viewed_at, $fields, $page, $per_page, $limit, $offset, $sorts, $filter_or)

Search Dashboards

Search Dashboards Returns an array of dashboard 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. The parameters `limit`, and `offset` are recommended for fetching results in page-size chunks. Get a single dashboard by id with dashboard()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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 dashboard id.
$slug = "slug_example"; // string | Match dashboard slug.
$title = "title_example"; // string | Match Dashboard title.
$description = "description_example"; // string | Match Dashboard description.
$content_favorite_id = "content_favorite_id_example"; // string | Filter on a content favorite id.
$folder_id = "folder_id_example"; // string | Filter on a particular space.
$deleted = "deleted_example"; // string | Filter on dashboards deleted status.
$user_id = "user_id_example"; // string | Filter on dashboards created by a particular user.
$view_count = "view_count_example"; // string | Filter on a particular value of view_count
$content_metadata_id = "content_metadata_id_example"; // string | Filter on a content favorite 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 dashboards 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 by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at]
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression

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

Parameters

Name	Type	Description	Notes
id	string	Match dashboard id.	[optional]
slug	string	Match dashboard slug.	[optional]
title	string	Match Dashboard title.	[optional]
description	string	Match Dashboard description.	[optional]
content_favorite_id	string	Filter on a content favorite id.	[optional]
folder_id	string	Filter on a particular space.	[optional]
deleted	string	Filter on dashboards deleted status.	[optional]
user_id	string	Filter on dashboards created by a particular user.	[optional]
view_count	string	Filter on a particular value of view_count	[optional]
content_metadata_id	string	Filter on a content favorite id.	[optional]
curate	bool	Exclude items that exist only in personal spaces other than the users	[optional]
last_viewed_at	string	Select dashboards 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 by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at]	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]

Return type

\Swagger\Client\Model\Dashboard[]

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]

syncLookmlDashboard

int[] syncLookmlDashboard($lookml_dashboard_id, $body, $raw_locale)

Sync LookML Dashboard

Update all linked dashboards to match the specified LookML dashboard. Any UDD (a dashboard which exists in the Looker database rather than as a LookML file) which has a `lookml_link_id` property value referring to a LookML dashboard's id (model::dashboardname) will be updated so that it matches the current state of the LookML dashboard. For this operation to succeed the user must have permission to view the LookML dashboard, and only linked dashboards that the user has permission to update will be synced. To link or unlink a UDD set the `lookml_link_id` property with update_dashboard()

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$lookml_dashboard_id = "lookml_dashboard_id_example"; // string | Id of LookML dashboard, in the form 'model::dashboardname'
$body = new \Swagger\Client\Model\Dashboard(); // \Swagger\Client\Model\Dashboard | Dashboard
$raw_locale = true; // bool | If true, and this dashboard is localized, export it with the raw keys, not localized.

try {
    $result = $apiInstance->syncLookmlDashboard($lookml_dashboard_id, $body, $raw_locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->syncLookmlDashboard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lookml_dashboard_id	string	Id of LookML dashboard, in the form 'model::dashboardname'
body	\Swagger\Client\Model\Dashboard	Dashboard
raw_locale	bool	If true, and this dashboard is localized, export it with the raw keys, not localized.	[optional]

Return type

int[]

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]

updateDashboard

\Swagger\Client\Model\Dashboard updateDashboard($dashboard_id, $body)

Update Dashboard

Update a dashboard You can use this function to change the string and integer properties of a dashboard. Nested objects such as filters, dashboard elements, or dashboard layout components cannot be modified by this function - use the update functions for the respective nested object types (like update_dashboard_filter() to change a filter) to modify nested objects referenced by a dashboard. If you receive a 422 error response when updating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard
$body = new \Swagger\Client\Model\Dashboard(); // \Swagger\Client\Model\Dashboard | Dashboard

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

Parameters

Name	Type	Description	Notes
dashboard_id	string	Id of dashboard
body	\Swagger\Client\Model\Dashboard	Dashboard

Return type

\Swagger\Client\Model\Dashboard

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]

updateDashboardElement

\Swagger\Client\Model\DashboardElement updateDashboardElement($dashboard_element_id, $body, $fields)

Update DashboardElement

Update the dashboard element with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_element_id = "dashboard_element_id_example"; // string | Id of dashboard element
$body = new \Swagger\Client\Model\DashboardElement(); // \Swagger\Client\Model\DashboardElement | DashboardElement
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_element_id	string	Id of dashboard element
body	\Swagger\Client\Model\DashboardElement	DashboardElement
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardElement

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]

updateDashboardFilter

\Swagger\Client\Model\DashboardFilter updateDashboardFilter($dashboard_filter_id, $body, $fields)

Update Dashboard Filter

Update the dashboard filter with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_filter_id = "dashboard_filter_id_example"; // string | Id of dashboard filter
$body = new \Swagger\Client\Model\DashboardFilter(); // \Swagger\Client\Model\DashboardFilter | Dashboard Filter
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_filter_id	string	Id of dashboard filter
body	\Swagger\Client\Model\DashboardFilter	Dashboard Filter
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardFilter

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]

updateDashboardLayout

\Swagger\Client\Model\DashboardLayout updateDashboardLayout($dashboard_layout_id, $body, $fields)

Update DashboardLayout

Update the dashboard layout with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_id = "dashboard_layout_id_example"; // string | Id of dashboard layout
$body = new \Swagger\Client\Model\DashboardLayout(); // \Swagger\Client\Model\DashboardLayout | DashboardLayout
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_layout_id	string	Id of dashboard layout
body	\Swagger\Client\Model\DashboardLayout	DashboardLayout
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayout

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]

updateDashboardLayoutComponent

\Swagger\Client\Model\DashboardLayoutComponent updateDashboardLayoutComponent($dashboard_layout_component_id, $body, $fields)

Update DashboardLayoutComponent

Update the dashboard element with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\DashboardApi(
    // 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()
);
$dashboard_layout_component_id = "dashboard_layout_component_id_example"; // string | Id of dashboard layout component
$body = new \Swagger\Client\Model\DashboardLayoutComponent(); // \Swagger\Client\Model\DashboardLayoutComponent | DashboardLayoutComponent
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
dashboard_layout_component_id	string	Id of dashboard layout component
body	\Swagger\Client\Model\DashboardLayoutComponent	DashboardLayoutComponent
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\DashboardLayoutComponent

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]

Files

DashboardApi.md

Latest commit

History

DashboardApi.md

File metadata and controls

Swagger\Client\DashboardApi

allDashboards

Get information about all active dashboards. Returns an array of abbreviated dashboard objects. Dashboards marked as deleted are excluded from this list. Get the full details of a specific dashboard by id with dashboard() Find deleted dashboards with search_dashboards()

Example

Parameters

Return type

Authorization

HTTP request headers

copyDashboard

Example

Parameters

Return type

Authorization

HTTP request headers

createDashboard

Example

Parameters

Return type

Authorization

HTTP request headers

createDashboardElement

Create a dashboard element on the dashboard with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

createDashboardFilter

Create a dashboard filter on the dashboard with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

createDashboardFromLookml

DEPRECATED: Use import_dashboard_from_lookml()

Example

Parameters

Return type

Authorization

HTTP request headers

createDashboardLayout

Create a dashboard layout on the dashboard with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

dashboard

Get information about a dashboard Returns the full details of the identified dashboard object Get a summary list of all active dashboards with all_dashboards() You can Search for dashboards with search_dashboards()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardAggregateTableLookml

Get Aggregate Table LookML for Each Query on a Dahboard Returns a JSON object that contains the dashboard id and Aggregate Table lookml

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardDashboardElements

Get information about all the dashboard elements on a dashboard with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardDashboardFilters

Get information about all the dashboard filters on a dashboard with a specific id.

Example

Parameters

Return type