Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FavoritesListOptionalParams

Package version

interface

An interface representing FavoritesListOptionalParams. Optional Parameters.

extends

RequestOptionsBase

Hierarchy

  • any
    • FavoritesListOptionalParams

Index

Properties

Optional canFetchContent

canFetchContent: undefined | false | true
member

{boolean} [canFetchContent] Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.

Optional favoriteType

favoriteType: FavoriteType
member

{FavoriteType} [favoriteType] The type of favorite. Value can be either shared or user. Possible values include: 'shared', 'user'. Default value: 'shared' .

Optional sourceType

sourceType: FavoriteSourceType
member

{FavoriteSourceType} [sourceType] Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum). Possible values include: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'funnel', 'impact', 'segmentation'

Optional tags

tags: string[]
member

{string[]} [tags] Tags that must be present on each favorite returned.

Generated using TypeDoc