Skip to main content

Import Market Assets Files Metadata from Investorflow

Overview​

This pipeline retrieves files metadata for specified market assets from Investorflow and stores this information in a Target Entity within your BuiltAPI Workspace. It uses Investorflow Asset IDs from a Source Entity to identify which assets' metadata to fetch.

Pipeline Parameters​

Name​

  • Type: String
  • Description: A user-defined name for this pipeline instance.
  • Example: "Import Investorflow Asset Files Metadata"

Source Entity Settings​

Configuration options for specifying the source of Investorflow Asset IDs.

  • Source Entity ("*")

    • Type: Entity
    • Description: The BuiltAPI entity that contains the Investorflow Asset IDs for which files metadata will be fetched. The question mark icon (?) in the UI provides more information.
    • Configuration: Select the appropriate entity from the dropdown menu. The asterisk (*) indicates this is a required field.

  • Source Entity Filter ("*")

    • Type: JSON (Mongo Query)
    • Description: Defines conditions under which records (containing Asset IDs) are selected from the Source Entity. Only assets identified by these records will have their metadata fetched. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a Mongo query JSON object that specifies filtering rules in the provided editor.
    • Default: "{}" (empty object, meaning all records if not limited by "Source Entity Take")

  • Source Entity Take ("*")

    • Type: Number
    • Description: Specifies the maximum number of records (and thus Asset IDs) to process from the Source Entity in a single run. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a number. Use the "-" and "+" buttons to decrement or increment the value.
    • Default: 10

  • Source Entity Only Updated ("*")

    • Type: Switch
    • Description: If enabled (toggled on), the pipeline will only process records from the Source Entity that have been updated since the last successful run. This is useful for fetching metadata only for newly relevant or changed assets. If disabled, all records matching the filter and "Source Entity Take" limit will be processed. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Default: Enabled (as indicated by the active state of the toggle in the UI)

Investorflow Get Assets Files Metadata Parameters​

Parameters specific to fetching asset files metadata from Investorflow. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Investorflow Asset ID ("*")

    • Type: Text Area (expects a JSONata expression or dot path)
    • Description: Specifies how to retrieve the Investorflow Asset ID from each processed Source Entity record. This ID is used to request the files metadata for the corresponding asset in Investorflow. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a JSONata expression or a dot path (e.g., "data.asset_id_investorflow") that extracts the Asset ID from the source record.

  • Investorflow Is Managed Assets ("*")

    • Type: Switch
    • Description: Indicates whether the assets for which metadata is being fetched are "Managed Assets" in Investorflow. This distinction might affect which API endpoint or parameters Investorflow uses. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Toggle on if the assets are managed, off otherwise.
    • Default: Disabled (as indicated by the inactive state of the toggle in the UI)

Target Entity Settings​

Configuration for storing the fetched metadata. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Target Entity ("*")
    • Type: Entity
    • Description: The BuiltAPI entity where the imported asset files metadata from Investorflow will be stored. Each fetched metadata set will typically correspond to a record in this entity. The question mark icon (?) in the UI provides more information.
    • Configuration: Select the appropriate entity from the dropdown menu. The asterisk (*) indicates this is a required field.