Class Analyses

Index

Constructors

constructor

Methods

create delete downloadScript edit getSnippetFile info list listSnippets run tokenGenerate uploadScript

Constructors

constructor

new Analyses(params: GenericModuleParams): Analyses
Parameters
- params: GenericModuleParams
Returns Analyses
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

create

create(analysisObj: AnalysisCreateInfo): Promise<{ id: string; token: string }>
Creates a new analysis in your application.
Parameters
- analysisObj: AnalysisCreateInfo
Returns Promise<{ id: string; token: string }>
See
https://help.tago.io/portal/en/kb/articles/120-creating-analysis Creating Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Create in Access Management.
```
const newAnalysis = await Resources.analysis.create({
  name: "My Analysis",
  type: "node",
  tags: [{ key: "type", value: "data-processing" }]
});
console.log(newAnalysis.id, newAnalysis.token); // analysis-id-123, analysis-token-123
```
- Defined in modules/Resources/Analyses.ts:91

delete

delete(analysisID: string): Promise<string>
Deletes an analysis from your application.
Parameters
- analysisID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Delete in Access Management.
```
const result = await Resources.analysis.delete("analysis-id-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Analyses.ts:142

downloadScript

downloadScript(
    analysisID: string,
    options?: { version?: number },
): Promise<
    { expire_at: Date; size: number; size_unit: string; url: string },
>
Gets a download URL for the analysis script.
Parameters
- analysisID: string
- Optionaloptions: { version?: number }
Returns Promise<{ expire_at: Date; size: number; size_unit: string; url: string }>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Download Analysis Script in Access Management.
```
const download = await Resources.analysis.downloadScript("analysis-id-123", { version: 1 });
console.log(download.url);
```
- Defined in modules/Resources/Analyses.ts:262

edit

edit(analysisID: string, analysisObj: Partial<AnalysisInfo>): Promise<string>
Modifies an existing analysis.
Parameters
- analysisID: string
- analysisObj: Partial<AnalysisInfo>
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Create in Access Management.
```
const result = await Resources.analysis.edit("analysis-id-123", {
  name: "Updated Analysis",
  active: false
});
console.log(result); // Successfully Updated
```
- Defined in modules/Resources/Analyses.ts:118

getSnippetFile

getSnippetFile(runtime: SnippetRuntime, filename: string): Promise<string>
Get the raw source code content of a specific snippet file. Fetches the actual code content from the TagoIO snippets repository.
Parameters
- runtime: SnippetRuntime
  The runtime environment the snippet belongs to
- filename: string
  The filename of the snippet to retrieve
Returns Promise<string>
Promise resolving to the raw file content as string
Example
```
// Get TypeScript code for console example
const code = await Resources.analysis.getSnippetFile("deno-rt2025", "console.ts");
console.log(code);

// Get Python code for data processing
const pythonCode = await Resources.analysis.getSnippetFile("python-rt2025", "avg-min-max.py");
console.log(pythonCode);
```
- Defined in modules/Resources/Analyses.ts:335

info

info(analysisID: string): Promise<AnalysisInfo>
Retrieves detailed information about a specific analysis.
Parameters
- analysisID: string
Returns Promise<AnalysisInfo>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Access in Access Management.
```
const analysisInfo = await Resources.analysis.info("analysis-id-123");
console.log(analysisInfo);
```
- Defined in modules/Resources/Analyses.ts:163

list

list<T extends AnalysisQuery>(
    queryObj?: T,
): Promise<
    AnalysisListItem<
        T["fields"] extends (keyof AnalysisInfo)[]
            ? any[any] extends readonly (string | number | symbol)[]
                ? any[any][number]
                : "id" | "name"
            : "id" | "name",
    >[],
>
Lists all analyses from the application with pagination support. Use this to retrieve and manage analyses in your application.
Type Parameters
- T extends AnalysisQuery
Parameters
- OptionalqueryObj: T
Returns Promise<
    AnalysisListItem<
        T["fields"] extends (keyof AnalysisInfo)[]
            ? any[any] extends readonly (string | number | symbol)[]
                ? any[any][number]
                : "id" | "name"
            : "id" | "name",
    >[],
>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Access in Access Management.
```
const list = await Resources.analysis.list({
  page: 1,
  fields: ["id", "name"],
  amount: 10,
  orderBy: ["name", "asc"]
});
console.log(list); // [ { id: 'analysis-id-123', name: 'Analysis Test', ...} ]
```
- Defined in modules/Resources/Analyses.ts:39

listSnippets

listSnippets(runtime: SnippetRuntime): Promise<SnippetsListResponse>
Get all available snippets for a specific runtime environment. Fetches analysis code snippets from the public TagoIO snippets repository.
Parameters
- runtime: SnippetRuntime
  The runtime environment to get snippets for
Returns Promise<SnippetsListResponse>
Promise resolving to the snippets metadata
Example
```
const denoSnippets = await Resources.analysis.listSnippets("deno-rt2025");

// Print all snippet titles
denoSnippets.snippets.forEach(snippet => {
  console.log(`${snippet.title}: ${snippet.description}`);
});
```
- Defined in modules/Resources/Analyses.ts:297

run

run(
analysisID: string,
scopeObj?: Record<string, any>,
): Promise<{ analysis_token: string }>
Executes an analysis with optional scope parameters.
Parameters
- analysisID: string
- OptionalscopeObj: Record<string, any>
Returns Promise<{ analysis_token: string }>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Run Analysis in Access Management.
```
const result = await Resources.analysis.run("analysis-id-123", { environment: "production" });
console.log(result.analysis_token);
```
- Defined in modules/Resources/Analyses.ts:186

tokenGenerate

tokenGenerate(analysisID: string): Promise<{ analysis_token: string }>
Generates a new token for the analysis.
Parameters
- analysisID: string
Returns Promise<{ analysis_token: string }>
Remarks
This is only allowed when the analysis is running in external mode.

See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const token = await resources.analysis.tokenGenerate("analysis-id-123");
console.log(token.analysis_token); // analysis-token-123
```
- Defined in modules/Resources/Analyses.ts:211

uploadScript

uploadScript(analysisID: string, fileObj: ScriptFile): Promise<string>
Uploads a script file to an analysis.
Parameters
- analysisID: string
- fileObj: ScriptFile
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/tagoio/analysis Analysis
Example
If receive an error "Authorization Denied", check policy Analysis / Upload Analysis Script in Access Management.
```
const result = await Resources.analysis.uploadScript("analysis-id-123", {
  name: "script.js",
  content: "base64-encoded-content",
  language: "node"
});
console.log(result);
```
- Defined in modules/Resources/Analyses.ts:236

Class Analyses

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Analyses

Methods

create

Parameters

Returns Promise<{ id: string; token: string }>

See

Example

delete

Parameters

Returns Promise<string>

See

Example

downloadScript

Parameters

Returns Promise<{ expire_at: Date; size: number; size_unit: string; url: string }>

See

Example

edit

Parameters

Returns Promise<string>

See

Example

getSnippetFile

Parameters

Returns Promise<string>

Example

info

Parameters

Returns Promise<AnalysisInfo>

See

Example

list

Type Parameters

Parameters

Returns Promise< AnalysisListItem< T["fields"] extends (keyof AnalysisInfo)[] ? any[any] extends readonly (string | number | symbol)[] ? any[any][number] : "id" | "name" : "id" | "name", >[],>

See

Example

listSnippets

Parameters

Returns Promise<SnippetsListResponse>

Example

run

Parameters

Returns Promise<{ analysis_token: string }>

See

Example

tokenGenerate

Parameters

Returns Promise<{ analysis_token: string }>

Remarks

See

Example

uploadScript

Parameters

Returns Promise<string>

See

Example

Settings

On This Page

Returns Promise<
AnalysisListItem<
T["fields"] extends (keyof AnalysisInfo)[]
? any[any] extends readonly (string | number | symbol)[]
? any[any][number]
: "id" | "name"
: "id" | "name",
>[],
>