Skip to main content

Data Asset Retrieval Documentation

Maestro is an API platform dedicated to efficient data management solutions. The provided schema retrieves data assets through its API by specifying parameters.

Contents​

About the project​

The provided schema describes the JSON payload structure for retrieving specific data assets in Maestro. Users can specify parameters to define which data assets to access, ensuring accurate and efficient extraction.

Prerequisites​

  • Access to the Maestro API.
  • Knowledge of the specific data assets you intend to retrieve.

Configuration​

Environment Variables​

The following environment variables are required to run the step:

  • DADOSFERA_USERNAME
  • DADOSFERA_PASSWORD

Parameters:​

  • maestro_base_url: The Maestro API base URL. Accepted values are https://maestro.dadosfera.ai and https://maestro.stg.dadosfera.ai.

  • output_variable_name: The name of the variable in which the resulting data will be stored.

  • additional_params: An array of filter parameters determining which data assets to retrieve. Each parameter is defined by a chave (filter name) and a valor (filter criterion).

Note: Set the correct base URL and specify the output variable carefully to ensure accurate extraction.

Configuration examples​

Retrieving all data assets for a pipeline_id​

{
  "maestro_base_url": "https://maestro.dadosfera.ai",
  "output_variable_name": "arbitrary_output_name",
  "additional_params": [
    {
      "key": "pipeline_id",
      "value": "28f8de4d-f46d-47a4-83fb-42069c1861ae"
    }
  ]
}

Retrieving all dashboards​

{
  "maestro_base_url": "https://maestro.dadosfera.ai",
  "output_variable_name": "arbitrary_output_name",
  "additional_params": [
    {
      "key": "data_asset_type",
      "value": "dashboard"
    }
  ]
}