Function getDirectAccessAgentBenchmarks

  • Retrieves paginated statuses for benchmarks run by the specified Direct Access agent. Use the filters and sort order to find benchmark runs and review their progress or completed results. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.17+.

    Parameters

    • agentId: string

      The agent ID

    • query: {
          filter?: string;
          limit?: number;
          page?: number;
          sort?:
              | "-benchmarkStartTime"
              | "+benchmarkStartTime"
              | "benchmarkStartTime"
              | "-benchmarkEndTime"
              | "+benchmarkEndTime"
              | "benchmarkEndTime"
              | "-dataTransmissionStartTime"
              | "+dataTransmissionStartTime"
              | "dataTransmissionStartTime"
              | "-dataTransmissionEndTime"
              | "+dataTransmissionEndTime"
              | "dataTransmissionEndTime";
      }

      an object with query parameters

      • Optionalfilter?: string

        SCIM style filter string as defined in RFC 7644 section 3.4.2.2

      • Optionallimit?: number

        The page size

      • Optionalpage?: number

        The page number

      • Optionalsort?:
            | "-benchmarkStartTime"
            | "+benchmarkStartTime"
            | "benchmarkStartTime"
            | "-benchmarkEndTime"
            | "+benchmarkEndTime"
            | "benchmarkEndTime"
            | "-dataTransmissionStartTime"
            | "+dataTransmissionStartTime"
            | "dataTransmissionStartTime"
            | "-dataTransmissionEndTime"
            | "+dataTransmissionEndTime"
            | "dataTransmissionEndTime"

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

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDirectAccessAgentBenchmarksHttpResponse>

    GetDirectAccessAgentBenchmarksHttpError

Settings
Member Visibility