Function getAdaptiveCards

Parameters

• query: {
      analysisTypes?: AnalysisTypeEnum[];
      appIds?: string[];
      breakdowns?: string[];
      categories?: string[];
      comparisonPeriods?: AggregationFrequencyEnum[];
      dimensions?: string[];
      limit?: number;
      measures?: string[];
      metricIds?: string[];
      next?: number;
      prev?: number;
      sort?: "creationTime" | "+creationTime" | "-creationTime";
      timeRangeEnd?: string;
      timeRangeStart?: string;
      type?: "measures" | "dimensions" | "breakdowns";
  }

  an object with query parameters

  • OptionalanalysisTypes?: AnalysisTypeEnum[]

    Filter by analysis type. Repeat the parameter to include multiple types. When this parameter is present, all matching results are returned regardless of ranking.

  • OptionalappIds?: string[]

    Filter by app ID(s). Use this to scope results to specific apps. When combined with measures, returns only cards matching BOTH criteria (AND logic). Repeat the parameter to supply multiple app IDs (OR logic within appIds).

    Recommendation: Use consistent parameter order for better HTTP cache hit rates:

    1. appIds (if present)
    2. measures (if present)
    3. other filters
    4. pagination (limit, next, prev)

    Example - One app, multiple measures: ?appIds=app-123&measures=Sum(Sales)&measures=Avg(Revenue)&measures=Count(Orders)

    Example - Multiple apps, one measure: ?appIds=app-retail&appIds=app-wholesale&measures=Sum(Sales)

    Example - Multiple apps, multiple measures: ?appIds=app-sales&appIds=app-hr&measures=Sum(Revenue)&measures=Avg(Salary)

  • Optionalbreakdowns?: string[]

    Filter by one or more breakdown selections in the form dimension:value (example Region:EMEA). Values are selected from the UI dropdown — not free text — and should match available dimension/value pairs. Repeat the parameter to supply multiple breakdowns; results match any of the provided breakdown pairs.

  • Optionalcategories?: string[]

    Filter by category IDs from the business glossary. Category filtering is not currently applied to the result set.

  • OptionalcomparisonPeriods?: AggregationFrequencyEnum[]

    Filter by comparison period. Example values: D, W, M, Q, Y. When this parameter is present, all matching results are returned regardless of ranking.

  • Optionaldimensions?: string[]

    Filter by dimension(s). Matching is case-sensitive; leading and trailing whitespace will be trimmed. Repeat the parameter to supply multiple dimensions.

  • Optionallimit?: number

    The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

  • Optionalmeasures?: string[]

    Filter by measure(s). Matching is case-sensitive; leading and trailing whitespace will be trimmed. Repeat the parameter to supply multiple measures.

  • OptionalmetricIds?: string[]

    Filter by metric ID. Repeat the parameter to supply multiple IDs. When omitted, returns cards for all metrics visible to the caller.

  • Optionalnext?: number

    The numeric offset to the next page of resources. Provide either the next or prev parameter, but not both.

  • Optionalprev?: number

    The numeric offset to the previous page of resources. Provide either the next or prev parameter, but not both.

  • Optionalsort?: "creationTime" | "+creationTime" | "-creationTime"

    The field to sort by, with +/- prefix indicating sort order

  • OptionaltimeRangeEnd?: string

    Exclusive upper bound for filtering by analysis result end time. Use ISO 8601 format.

  • OptionaltimeRangeStart?: string

    Inclusive lower bound for filtering by analysis result end time. Use ISO 8601 format.

  • Optionaltype?: "measures" | "dimensions" | "breakdowns"

    Filter by Adaptive Card category. When omitted, cards from all categories are returned.

• Optionaloptions: ApiCallOptions