Class CreateSnapshotDataAttributesRequest

Attributes for snapshot creation.

Hierarchy

  • CreateSnapshotDataAttributesRequest

Constructors

constructor

Properties

additionalConfig? additionalProperties? end height? isAuthenticated? start ttl? widgetDefinition width?

Constructors

constructor

Properties

Optional additionalConfig

additionalConfig?: CreateSnapshotAdditionalConfig

Additional configuration options for snapshot creation.

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

end

end: number

End of the time window for the snapshot, in milliseconds since Unix epoch.

Optional height

height?: number

The height of the rendered snapshot in pixels.

Optional isAuthenticated

isAuthenticated?: boolean

Whether the snapshot requires authentication to view. Authenticated snapshots are scoped to the creating organization.

start

start: number

Start of the time window for the snapshot, in milliseconds since Unix epoch.

Optional ttl

ttl?: CreateSnapshotTTL

The time-to-live for the snapshot. This value corresponds to storage lifecycle policies that automatically delete the snapshot after the specified period.

widgetDefinition

widgetDefinition: {
    [key: string]: any;
}

The widget definition to render as a snapshot. Must include a valid type field and non-empty requests array.

Type declaration

  • [key: string]: any

Optional width

width?: number

The width of the rendered snapshot in pixels.

Settings

Member Visibility

Theme

Generated using TypeDoc