sdk.analysis_config.get()

Get Analysis Configs.

Retrieve the metadata of a particular Analysis Config.

Parameters

ids (List[str]) - list of Analysis Configs to retrieve
[Optional] include_algorithm_details (bool) - flag to include Algorithm Version details including metadata and manifest, default is False

Returns

List[AnalysisConfig]

Example(s)

# Get an Analysis Config
await sdk.analysis_config.get(ids=["ac9f25c2-48ba-48b1-b096-ac3d0ec83c21"])

# Output (List[AnalysisConfig])
[analysis_version {
  id: "c4f5c5db-cd81-403c-a0b3-e486ba47315f"
  analysis {
    id: "96b49764-007d-4166-9a5f-600b9bfa9ba6"
    author: "papi_author-vulcan-oi1"
    created_on {
      seconds: 1666659190
      nanos: 698822000
    }
    name: "Device Traceability"
  }
  analysis_manifest {
    manifest_version: "0.0.5"
    metadata {
      description: "Spatial representation of the device-level before and after locations of devices that visit an AOI"
      version: "0.0.2"
      tags: "traceability"
      tags: "device"
      tags: "movement"
      tags: "ais"
      tags: "adsb"
    }
    algorithm_nodes {
      name: "device-visits"
      algorithm_version_id: "5ee03b8e-ab45-4553-b5f4-a5029254a9de"
      children: "device-tracks"
    }
    algorithm_nodes {
      name: "device-tracks"
      algorithm_version_id: "6f7cff18-c2a2-4246-b0d4-21be09673a6b"
    }
  }
  created_on {
    seconds: 1666811979
    nanos: 404862000
  }
}
id: "ac9f25c2-48ba-48b1-b096-ac3d0ec83c21"
name: "My Awesome Analysis Config"
description: "Analysis Config with Device Visits and Device Tracks"
created_on {
  seconds: 1667409060
  nanos: 531280000
}
algorithm_config_nodes {
  name: "device-tracks"
  algorithm_config_id: "d6ac507f-21bf-4618-8083-608f9102db5b"
}
algorithm_config_nodes {
  name: "device-visits"
  algorithm_config_id: "930ec002-ee5a-4449-a789-6b37e3e724d2"
}
]