Skip to main content

WorkstreamSummary

This is representation or a summarized version of the highly relevant WorkstreamEvent events from a given time period, 1 day, 1 week, 1 month, dependinng on your given flow.

Properties

NameType
schemaEmbeddedModelSchema
idstring
scoreScore
createdGroupedTimestamp
updatedGroupedTimestamp
eventsFlattenedWorkstreamEvents
namestring
annotationsFlattenedAnnotations
rangesFlattenedRanges
modelModel
websitesFlattenedWebsites
anchorsFlattenedAnchors
assetsFlattenedAssets
conversationsFlattenedConversations
personsFlattenedPersons
applicationsApplications

Example

import { WorkstreamSummary } from '@pieces.app/pieces-os-client'

// TODO: Update the object below with actual values
const example: WorkstreamSummary = {
"schema": null,
"id": null,
"score": null,
"created": null,
"updated": null,
"events": null,
"name": null,
"annotations": null,
"ranges": null,
"model": null,
"websites": null,
"anchors": null,
"assets": null,
"conversations": null,
"persons": null,
"applications": null,
}

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as WorkstreamSummary
console.log(exampleParsed)