Swagger\Client\ContentApi

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

Method	HTTP request	Description
allContentMetadataAccesses	GET /content_metadata_access	Get All Content Metadata Accesses
allContentMetadatas	GET /content_metadata	Get All Content Metadatas
contentFavorite	GET /content_favorite/{content_favorite_id}	Get Favorite Content
contentMetadata	GET /content_metadata/{content_metadata_id}	Get Content Metadata
contentThumbnail	GET /content_thumbnail/{type}/{resource_id}	Get Content Thumbnail
contentValidation	GET /content_validation	Validate Content
createContentFavorite	POST /content_favorite	Create Favorite Content
createContentMetadataAccess	POST /content_metadata_access	Create Content Metadata Access
deleteContentFavorite	DELETE /content_favorite/{content_favorite_id}	Delete Favorite Content
deleteContentMetadataAccess	DELETE /content_metadata_access/{content_metadata_access_id}	Delete Content Metadata Access
searchContentFavorites	GET /content_favorite/search	Search Favorite Contents
searchContentViews	GET /content_view/search	Search Content Views
updateContentMetadata	PATCH /content_metadata/{content_metadata_id}	Update Content Metadata
updateContentMetadataAccess	PUT /content_metadata_access/{content_metadata_access_id}	Update Content Metadata Access
vectorThumbnail	GET /vector_thumbnail/{type}/{resource_id}	Get Vector Thumbnail

allContentMetadataAccesses

\Swagger\Client\Model\ContentMetaGroupUser[] allContentMetadataAccesses($content_metadata_id, $fields)

Get All Content Metadata Accesses

All content metadata access records for a content metadata item.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_metadata_id = "content_metadata_id_example"; // string | Id of content metadata
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
content_metadata_id	string	Id of content metadata
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ContentMetaGroupUser[]

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]

allContentMetadatas

\Swagger\Client\Model\ContentMeta[] allContentMetadatas($parent_id, $fields)

Get All Content Metadatas

Get information about all content metadata in a space.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$parent_id = "parent_id_example"; // string | Parent space of content.
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
parent_id	string	Parent space of content.
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ContentMeta[]

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]

contentFavorite

\Swagger\Client\Model\ContentFavorite contentFavorite($content_favorite_id, $fields)

Get Favorite Content

Get favorite content by its id

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_favorite_id = "content_favorite_id_example"; // string | Id of favorite content
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
content_favorite_id	string	Id of favorite content
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ContentFavorite

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]

contentMetadata

\Swagger\Client\Model\ContentMeta contentMetadata($content_metadata_id, $fields)

Get Content Metadata

Get information about an individual content metadata record.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_metadata_id = "content_metadata_id_example"; // string | Id of content metadata
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
content_metadata_id	string	Id of content metadata
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ContentMeta

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]

contentThumbnail

string contentThumbnail($type, $resource_id, $reload, $format, $width, $height)

Get Content Thumbnail

Get an image representing the contents of a dashboard or look. The returned thumbnail is an abstract representation of the contents of a dashbord or look and does not reflect the actual data displayed in the respective visualizations.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$type = "type_example"; // string | Either dashboard or look
$resource_id = "resource_id_example"; // string | ID of the dashboard or look to render
$reload = "reload_example"; // string | Whether or not to refresh the rendered image with the latest content
$format = "format_example"; // string | A value of png produces a thumbnail in PNG format instead of SVG (default)
$width = 789; // int | The width of the image if format is supplied
$height = 789; // int | The height of the image if format is supplied

try {
    $result = $apiInstance->contentThumbnail($type, $resource_id, $reload, $format, $width, $height);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->contentThumbnail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
type	string	Either dashboard or look
resource_id	string	ID of the dashboard or look to render
reload	string	Whether or not to refresh the rendered image with the latest content	[optional]
format	string	A value of png produces a thumbnail in PNG format instead of SVG (default)	[optional]
width	int	The width of the image if format is supplied	[optional]
height	int	The height of the image if format is supplied	[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: image/svg+xml, image/png

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

contentValidation

\Swagger\Client\Model\ContentValidation contentValidation($fields)

Validate Content

Validate All Content Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

Example

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

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

Parameters

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

Return type

\Swagger\Client\Model\ContentValidation

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]

createContentFavorite

\Swagger\Client\Model\ContentFavorite createContentFavorite($body)

Create Favorite Content

Create favorite content

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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\ContentFavorite(); // \Swagger\Client\Model\ContentFavorite | Favorite Content

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ContentFavorite	Favorite Content

Return type

\Swagger\Client\Model\ContentFavorite

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]

createContentMetadataAccess

\Swagger\Client\Model\ContentMetaGroupUser createContentMetadataAccess($body, $send_boards_notification_email)

Create Content Metadata Access

Create content metadata access.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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\ContentMetaGroupUser(); // \Swagger\Client\Model\ContentMetaGroupUser | Content Metadata Access
$send_boards_notification_email = true; // bool | Optionally sends notification email when granting access to a board.

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ContentMetaGroupUser	Content Metadata Access
send_boards_notification_email	bool	Optionally sends notification email when granting access to a board.	[optional]

Return type

\Swagger\Client\Model\ContentMetaGroupUser

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]

deleteContentFavorite

string deleteContentFavorite($content_favorite_id)

Delete Favorite Content

Delete favorite content

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_favorite_id = "content_favorite_id_example"; // string | Id of favorite content

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

Parameters

Name	Type	Description	Notes
content_favorite_id	string	Id of favorite content

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]

deleteContentMetadataAccess

string deleteContentMetadataAccess($content_metadata_access_id)

Delete Content Metadata Access

Remove content metadata access.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_metadata_access_id = "content_metadata_access_id_example"; // string | Id of content metadata access

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

Parameters

Name	Type	Description	Notes
content_metadata_access_id	string	Id of content metadata access

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]

searchContentFavorites

\Swagger\Client\Model\ContentFavorite[] searchContentFavorites($id, $user_id, $content_metadata_id, $dashboard_id, $look_id, $board_id, $limit, $offset, $sorts, $fields, $filter_or)

Search Favorite Contents

Search Favorite Content 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\ContentApi(
    // 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 content favorite id(s)
$user_id = "user_id_example"; // string | Match user id(s).To create a list of multiple ids, use commas as separators
$content_metadata_id = "content_metadata_id_example"; // string | Match content metadata id(s).To create a list of multiple ids, use commas as separators
$dashboard_id = "dashboard_id_example"; // string | Match dashboard id(s).To create a list of multiple ids, use commas as separators
$look_id = "look_id_example"; // string | Match look id(s).To create a list of multiple ids, use commas as separators
$board_id = "board_id_example"; // string | Match board id(s).To create a list of multiple ids, use commas as separators
$limit = 789; // int | Number of results to return. (used with offset)
$offset = 789; // int | Number of results to skip before returning any. (used with limit)
$sorts = "sorts_example"; // string | Fields to sort by.
$fields = "fields_example"; // string | Requested fields.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression

try {
    $result = $apiInstance->searchContentFavorites($id, $user_id, $content_metadata_id, $dashboard_id, $look_id, $board_id, $limit, $offset, $sorts, $fields, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->searchContentFavorites: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Match content favorite id(s)	[optional]
user_id	string	Match user id(s).To create a list of multiple ids, use commas as separators	[optional]
content_metadata_id	string	Match content metadata id(s).To create a list of multiple ids, use commas as separators	[optional]
dashboard_id	string	Match dashboard id(s).To create a list of multiple ids, use commas as separators	[optional]
look_id	string	Match look id(s).To create a list of multiple ids, use commas as separators	[optional]
board_id	string	Match board id(s).To create a list of multiple ids, use commas as separators	[optional]
limit	int	Number of results to return. (used with offset)	[optional]
offset	int	Number of results to skip before returning any. (used with limit)	[optional]
sorts	string	Fields to sort by.	[optional]
fields	string	Requested fields.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]

Return type

\Swagger\Client\Model\ContentFavorite[]

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]

searchContentViews

\Swagger\Client\Model\ContentView[] searchContentViews($view_count, $group_id, $look_id, $dashboard_id, $content_metadata_id, $start_of_week_date, $all_time, $user_id, $fields, $limit, $offset, $sorts, $filter_or)

Search Content Views

Search Content Views 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\ContentApi(
    // 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()
);
$view_count = "view_count_example"; // string | Match view count
$group_id = "group_id_example"; // string | Match Group Id
$look_id = "look_id_example"; // string | Match look_id
$dashboard_id = "dashboard_id_example"; // string | Match dashboard_id
$content_metadata_id = "content_metadata_id_example"; // string | Match content metadata id
$start_of_week_date = "start_of_week_date_example"; // string | Match start of week date (format is \"YYYY-MM-DD\")
$all_time = true; // bool | True if only all time view records should be returned
$user_id = "user_id_example"; // string | Match user id
$fields = "fields_example"; // string | Requested fields
$limit = 789; // int | Number of results to return. Use with `offset` to manage pagination of results
$offset = 789; // int | Number of results to skip before returning data
$sorts = "sorts_example"; // string | Fields to sort by
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression

try {
    $result = $apiInstance->searchContentViews($view_count, $group_id, $look_id, $dashboard_id, $content_metadata_id, $start_of_week_date, $all_time, $user_id, $fields, $limit, $offset, $sorts, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->searchContentViews: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
view_count	string	Match view count	[optional]
group_id	string	Match Group Id	[optional]
look_id	string	Match look_id	[optional]
dashboard_id	string	Match dashboard_id	[optional]
content_metadata_id	string	Match content metadata id	[optional]
start_of_week_date	string	Match start of week date (format is "YYYY-MM-DD")	[optional]
all_time	bool	True if only all time view records should be returned	[optional]
user_id	string	Match user id	[optional]
fields	string	Requested fields	[optional]
limit	int	Number of results to return. Use with `offset` to manage pagination of results	[optional]
offset	int	Number of results to skip before returning data	[optional]
sorts	string	Fields to sort by	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]

Return type

\Swagger\Client\Model\ContentView[]

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]

updateContentMetadata

\Swagger\Client\Model\ContentMeta updateContentMetadata($content_metadata_id, $body)

Update Content Metadata

Move a piece of content.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_metadata_id = "content_metadata_id_example"; // string | Id of content metadata
$body = new \Swagger\Client\Model\ContentMeta(); // \Swagger\Client\Model\ContentMeta | Content Metadata

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

Parameters

Name	Type	Description	Notes
content_metadata_id	string	Id of content metadata
body	\Swagger\Client\Model\ContentMeta	Content Metadata

Return type

\Swagger\Client\Model\ContentMeta

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]

updateContentMetadataAccess

\Swagger\Client\Model\ContentMetaGroupUser updateContentMetadataAccess($content_metadata_access_id, $body)

Update Content Metadata Access

Update type of access for content metadata.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$content_metadata_access_id = "content_metadata_access_id_example"; // string | Id of content metadata access
$body = new \Swagger\Client\Model\ContentMetaGroupUser(); // \Swagger\Client\Model\ContentMetaGroupUser | Content Metadata Access

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

Parameters

Name	Type	Description	Notes
content_metadata_access_id	string	Id of content metadata access
body	\Swagger\Client\Model\ContentMetaGroupUser	Content Metadata Access

Return type

\Swagger\Client\Model\ContentMetaGroupUser

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]

vectorThumbnail

string vectorThumbnail($type, $resource_id, $reload)

Get Vector Thumbnail

Get a vector image representing the contents of a dashboard or look. # DEPRECATED: Use content_thumbnail() The returned thumbnail is an abstract representation of the contents of a dashbord or look and does not reflect the actual data displayed in the respective visualizations.

Example

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

$apiInstance = new Swagger\Client\Api\ContentApi(
    // 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()
);
$type = "type_example"; // string | Either dashboard or look
$resource_id = "resource_id_example"; // string | ID of the dashboard or look to render
$reload = "reload_example"; // string | Whether or not to refresh the rendered image with the latest content

try {
    $result = $apiInstance->vectorThumbnail($type, $resource_id, $reload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->vectorThumbnail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
type	string	Either dashboard or look
resource_id	string	ID of the dashboard or look to render
reload	string	Whether or not to refresh the rendered image with the latest content	[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: image/svg+xml

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

Files

ContentApi.md

Latest commit

History

ContentApi.md

File metadata and controls

Swagger\Client\ContentApi

allContentMetadataAccesses

All content metadata access records for a content metadata item.

Example

Parameters

Return type

Authorization

HTTP request headers

allContentMetadatas

Get information about all content metadata in a space.

Example

Parameters

Return type

Authorization

HTTP request headers

contentFavorite

Get favorite content by its id

Example

Parameters

Return type

Authorization

HTTP request headers

contentMetadata

Get information about an individual content metadata record.

Example

Parameters

Return type

Authorization

HTTP request headers

contentThumbnail

Get an image representing the contents of a dashboard or look. The returned thumbnail is an abstract representation of the contents of a dashbord or look and does not reflect the actual data displayed in the respective visualizations.

Example

Parameters

Return type

Authorization

HTTP request headers

contentValidation

Validate All Content Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

Example

Parameters

Return type

Authorization

HTTP request headers

createContentFavorite

Create favorite content

Example

Parameters

Return type

Authorization

HTTP request headers

createContentMetadataAccess

Create content metadata access.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContentFavorite

Delete favorite content

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContentMetadataAccess

Remove content metadata access.

Example

Parameters

Return type

Authorization

HTTP request headers

searchContentFavorites

Example

Parameters