Function getDataAlertRecipientStats

  • Retrieve the recipient stats for a data alerting task.

    Parameters

    • alertId: string

      The alerting task identifier.

    • query: {
          groups?: string[];
          sort?: ("+userID" | "-userID" | "subscribed" | "+subscribed")[];
          subscribed?: boolean;
          userID?: string;
      }

      an object with query parameters

      • Optionalgroups?: string[]

        The name of the groups you would like to filter by

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

        Sort the returned result set by the specified field

      • Optionalsubscribed?: boolean

        Subscribed property you would like to filter by

      • OptionaluserID?: string

        The recipients ID you would like to filter by

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDataAlertRecipientStatsHttpResponse>

    GetDataAlertRecipientStatsHttpError