Function getDataAlertExecutions

  • Lists executions for the specified data alerting task.

    Parameters

    • taskId: string

      The alerting task identifier.

    • query: {
          conditionId?: string;
          conditionStatus?: "FAILED" | "FINISHED" | "ALL";
          daysOfMonth?: number[];
          daysOfWeek?: (
              | "MONDAY"
              | "TUESDAY"
              | "WEDNESDAY"
              | "THURSDAY"
              | "FRIDAY"
              | "SATURDAY"
              | "SUNDAY"
          )[];
          fields?: (
              | "evaluationId"
              | "triggerTime"
              | "conditionStatus"
              | "executionEvaluationStatus"
              | "evaluation"
              | "evaluation.endTime"
              | "evaluation.resultData"
              | "evaluation.resultData.count"
              | "evaluation.resultData.headers"
              | "evaluation.resultData.positive"
              | "evaluation.resultData.negative"
              | "evaluation.resultData.dimensions"
              | "evaluation.resultData.measures"
          )[];
          includeEvaluation?: boolean;
          lastEachDay?: boolean;
          limit?: number;
          minimumGapDays?: number;
          next?: string;
          offset?: number;
          prev?: string;
          searchResultsLimit?: number;
          since?: string;
          sort?: ("triggertime" | "-triggertime" | "+triggertime")[];
          timezone?: string;
          triggered?: boolean;
          until?: string;
      }

      an object with query parameters

      • OptionalconditionId?: string

        Filter by condition id related to the executions.

      • OptionalconditionStatus?: "FAILED" | "FINISHED" | "ALL"

        Filter by whether the alerting task execution status is FINISHED or FAILED.

      • OptionaldaysOfMonth?: number[]

        Specifies required days of the month that the execution was created in

      • OptionaldaysOfWeek?: (
            | "MONDAY"
            | "TUESDAY"
            | "WEDNESDAY"
            | "THURSDAY"
            | "FRIDAY"
            | "SATURDAY"
            | "SUNDAY"
        )[]

        Specifies a filter for custom handled periods of time in which the executions were handled

      • Optionalfields?: (
            | "evaluationId"
            | "triggerTime"
            | "conditionStatus"
            | "executionEvaluationStatus"
            | "evaluation"
            | "evaluation.endTime"
            | "evaluation.resultData"
            | "evaluation.resultData.count"
            | "evaluation.resultData.headers"
            | "evaluation.resultData.positive"
            | "evaluation.resultData.negative"
            | "evaluation.resultData.dimensions"
            | "evaluation.resultData.measures"
        )[]

        Specifies specific properties to be populated

      • OptionalincludeEvaluation?: boolean

        Specifies whether to include evaluation details

      • OptionallastEachDay?: boolean

        Specifies whether to only show the last execution in each day

      • Optionallimit?: number

        Limit the returned result set

      • OptionalminimumGapDays?: number

        Specifies the number of days required between each entry. This should require a sort by triggertime

      • Optionalnext?: string

        The cursor to the next page of data. Only one of next or previous may be specified.

      • Optionaloffset?: number

        Offset for pagination - how many elements to skip

      • Optionalprev?: string

        The cursor to the previous page of data. Only one of next or previous may be specified.

      • OptionalsearchResultsLimit?: number

        Specifies a limit number for the search query, affects total count and is not related to pagination

      • Optionalsince?: string

        Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z

      • Optionalsort?: ("triggertime" | "-triggertime" | "+triggertime")[]

        Sort the returned result set by the specified field

      • Optionaltimezone?: string

        Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles

      • Optionaltriggered?: boolean

        Filter by whether the alerting task is triggered.

      • Optionaluntil?: string

        Specifies a date that executions should have been created before. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDataAlertExecutionsHttpResponse>

    GetDataAlertExecutionsHttpError