Dashboards
(dashboards)
Overview
Operations related to dashboards. Currently the API/SDK only supports fetching basic information about dashboards.
Available Operations
- postListDashboard - Post List Dashboards
- postGetDashboard - Post Fetch Info
postSessionEventsDashboard- Post Session Events :warning: DeprecatedpostSessionSummaryDashboard- Post Session Summary :warning: DeprecatedpostSessionTransfersDashboard- Post Session Transfers :warning: DeprecatedpostSessionsDashboard- Post Sessions :warning: Deprecated
postListDashboard
METHOD: POST URL: /dashboard/list ARGUMENTS: None RETURNS: List of dashboards
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | operations.PostListDashboardRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.ListResponseDashboardResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
postGetDashboard
METHOD: POST URL: /dashboard/fetch_info ARGUMENTS: None RETURNS: Dashboard info for embedding
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | operations.PostGetDashboardRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.DashboardTokenResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
postSessionEventsDashboard
METHOD: POST URL: /dashboard/session_events ARGUMENTS: None RETURNS: Dashboard info for embedding DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
:warning: DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Dashboard>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.SDKError | 4XX, 5XX | */* |
postSessionSummaryDashboard
METHOD: POST URL: /dashboard/session_summary ARGUMENTS: None RETURNS: Dashboard info for embedding DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
:warning: DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Dashboard>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.SDKError | 4XX, 5XX | */* |
postSessionTransfersDashboard
METHOD: POST URL: /dashboard/session_transfers ARGUMENTS: None RETURNS: Dashboard info for embedding DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
:warning: DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Dashboard>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.SDKError | 4XX, 5XX | */* |
postSessionsDashboard
METHOD: POST URL: /dashboard/sessions ARGUMENTS: None RETURNS: Dashboard info for embedding DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
:warning: DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Dashboard>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.SDKError | 4XX, 5XX | */* |