Interface SnapshotInterface

Snapshot entity interface

Mirrors macs-node-sdk/lib/logs/models/snapshot.js. A point-in-time capture of a source document (currently only AgentLog). Required on create: source + data.

interface SnapshotInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    source: string;
    type?: "AGENT_LOG";
    data: any;
    keywords?: string[];
    tags?: string[];
    active?: boolean;
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? org? user? source type? data keywords? tags? active?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

source

source: string

ObjectId of the source document being snapshotted (required)

Optionaltype

type?: "AGENT_LOG"

Snapshot kind (currently always 'AGENT_LOG')

data

data: any

Snapshot payload — shape depends on type

Optionalkeywords

keywords?: string[]

Optionaltags

tags?: string[]

Optionalactive

active?: boolean

Whether the entity is active

Settings

Member Visibility

On This Page

Properties