Skip to main content

Create Shareable

POST 
/shared/

Create Shareable

Request​

Body

required
    owner_id Owner Id

    The ID of the user the object belongs to

    _id Id

    The unique identifier for the object

    created_at date-time

    The time the view was created

    scan_id Scan Idrequired

    Item ID that's being shared

    view_id View Id

    ID for the data view that the summary should be shown in context of

    view_name View Name

    The name of the view

    view object
    owner_id Owner Id

    The ID of the user the object belongs to

    _id Id

    The unique identifier for the object

    created_at date-time

    The time the view was created

    name Namerequired

    The name of the view

    join_by Join By

    The column to join by

    fuzzy_queries string[]

    Default value: ``

    The fuzzy queries

    strict_queries string[]

    Default value: ``

    The strict queries

    path_queries string[]

    Default value: ``

    The path queries

    sort_by Sort By

    The path to sort by

    sort_direction Sort Direction

    The direction to sort, 1 for ascending, -1 for descending

    included_paths string[]

    Default value: ``

    The paths to include, if empty, calculate the 'most useful' paths from data

    scanner_account_ids string[]

    Default value: ``

    The scanner account IDs to include data from, if empty, include all

    flow_ids string[]

    Default value: ``

    The flow IDs to include data from, if empty, include all

    custom_column_names object

    The column names, maps form paths to names

    property name* string
    not_null_paths string[]

    Default value: ``

    The paths that must not be null

    ranking_number Ranking Number

    Default value: 1

    Primary sorting key in result return, used to determine the rank of this view in the list of views in UI, lower is earlier. Set by user.

    timezone Timezone

    The display and export timezone

    last_exported_at date-time

    The time the view was last exported

    logo_base64 Logo Base64

    The base64 encoded logo to be shown on exports. Max 50KiB.

    hide_timestamps Hide Timestamps

    Default value: false

    Whether to hide the timestamps in the shared timeline view

    expiry date-timerequired

    The time the sharable will expire. Null for never

    active Active

    Default value: true

    Whether the sharable is still active

Responses​

Successful Response

Schema

    string

Loading...