(dashboards)

​
Overview

Operations related to dashboards. Currently the API/SDK only supports fetching basic information about dashboards.

​
Available Operations

​
postSessionEventsDashboard

METHOD: POST URL: /dashboard/session_events ARGUMENTS: None RETURNS: Dashboard info for embedding

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dashboards.postSessionEventsDashboard();

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dashboardsPostSessionEventsDashboard } from "syllable-sdk/funcs/dashboardsPostSessionEventsDashboard.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dashboardsPostSessionEventsDashboard(syllableSDK);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions 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.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.Dashboard>

​
Errors

Error TypeStatus CodeContent Type
errors.SDKError4XX, 5XX*/*

​
postSessionSummaryDashboard

METHOD: POST URL: /dashboard/session_summary ARGUMENTS: None RETURNS: Dashboard info for embedding

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dashboards.postSessionSummaryDashboard();

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dashboardsPostSessionSummaryDashboard } from "syllable-sdk/funcs/dashboardsPostSessionSummaryDashboard.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dashboardsPostSessionSummaryDashboard(syllableSDK);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions 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.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.Dashboard>

​
Errors

Error TypeStatus CodeContent Type
errors.SDKError4XX, 5XX*/*

​
postSessionTransfersDashboard

METHOD: POST URL: /dashboard/session_transfers ARGUMENTS: None RETURNS: Dashboard info for embedding

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dashboards.postSessionTransfersDashboard();

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dashboardsPostSessionTransfersDashboard } from "syllable-sdk/funcs/dashboardsPostSessionTransfersDashboard.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dashboardsPostSessionTransfersDashboard(syllableSDK);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions 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.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.Dashboard>

​
Errors

Error TypeStatus CodeContent Type
errors.SDKError4XX, 5XX*/*

​
postSessionsDashboard

METHOD: POST URL: /dashboard/sessions ARGUMENTS: None RETURNS: Dashboard info for embedding

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dashboards.postSessionsDashboard();

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dashboardsPostSessionsDashboard } from "syllable-sdk/funcs/dashboardsPostSessionsDashboard.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dashboardsPostSessionsDashboard(syllableSDK);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions 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.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.Dashboard>

​
Errors

Error TypeStatus CodeContent Type
errors.SDKError4XX, 5XX*/*
SessionLabelsTest