Skip to main content

@wildix/wda-insights-client > ListConversationsInsightsAggregationsCommand

ListConversationsInsightsAggregationsCommand class​

Lists nested drill-down data showing relationships between dimensions.

Signature:

export declare class ListConversationsInsightsAggregationsCommand extends ListConversationsInsightsAggregationsCommand_base

Extends: ListConversationsInsightsAggregationsCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { WdaInsightsClient, ListConversationsInsightsAggregationsCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, ListConversationsInsightsAggregationsCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // ListConversationsInsightsAggregationsInput
  company: "STRING_VALUE",
  aggregations: [ // AggregationDefinitionsList // required
    { // AggregationDefinition Union: only one key present
      projection: { // AggregationProjectionDefinition
        id: "STRING_VALUE", // required
        fieldId: "STRING_VALUE", // required
      },
      direction: {},
      duration: { // AggregationDurationDefinition
        buckets: [ // DurationGroupBucketsList
          { // DurationGroupBucket
            title: "STRING_VALUE", // required
            from: Number("int"),
            to: Number("int"),
          },
        ],
      },
      service: {},
      extension: {},
      group: {},
      type: {},
      recorded: {},
      date: { // AggregationDateDefinition
        interval: "year" || "quarter" || "month" || "week" || "day" || "hour" || "minute", // required
        timeZone: "STRING_VALUE",
      },
      dayOfWeek: { // AggregationDayOfWeekDefinition
        timeZone: "STRING_VALUE",
      },
      hourOfDay: {},
    },
  ],
  filter: { // ListConversationsFilter
    participants: [ // ListConversationsFilterParticipantList
      { // ListConversationsFilterParticipant Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    participantsToInclude: [
      {//  Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    participantsToExclude: [
      {//  Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    service: [ // ListConversationsFilterService
      "STRING_VALUE",
    ],
    phases: [ // ListConversationsFilterPhases
      "STRING_VALUE",
    ],
    language: [ // ListConversationsFilterLanguage
      "STRING_VALUE",
    ],
    duration: { // ListConversationsFilterDuration
      from: Number("int"),
      to: Number("int"),
    },
    recorded: true || false,
    transcribed: true || false,
    direction: { // ListConversationsFilterDirection
      inbound: true || false,
      outbound: true || false,
      internal: true || false,
    },
    insights: [ // ListConversationsFilterInsightsList
      { // ListConversationsFilterInsight
        projectionId: "STRING_VALUE", // required
        fieldId: "STRING_VALUE", // required
        match: "STRING_VALUE",
        matchAny: [ // StringList
          "STRING_VALUE",
        ],
      },
    ],
    date: { // ListConversationsFilterDate Union: only one key present
      absolute: { // ListConversationsFilterAbsoluteDate
        from: "STRING_VALUE",
        to: "STRING_VALUE",
        timeZone: "STRING_VALUE",
      },
      predefined: { // ListConversationsFilterPredefinedDate
        type: "THIS_QUARTER" || "THIS_MONTH" || "THIS_WEEK" || "TODAY" || "YESTERDAY" || "PREVIOUS_WEEK" || "PREVIOUS_MONTH" || "LAST_30_DAYS", // required
        timeZone: "STRING_VALUE",
      },
    },
  },
};
const command = new ListConversationsInsightsAggregationsCommand(input);
const response = await client.send(command);
// { // ListConversationsInsightsAggregationsOutput
//   count: Number("int"), // required
//   result: { // AggregationResult
//     aggregation: { // AggregationDefinition Union: only one key present
//       projection: { // AggregationProjectionDefinition
//         id: "STRING_VALUE", // required
//         fieldId: "STRING_VALUE", // required
//       },
//       direction: {},
//       duration: { // AggregationDurationDefinition
//         buckets: [ // DurationGroupBucketsList
//           { // DurationGroupBucket
//             title: "STRING_VALUE", // required
//             from: Number("int"),
//             to: Number("int"),
//           },
//         ],
//       },
//       service: {},
//       extension: {},
//       group: {},
//       type: {},
//       recorded: {},
//       date: { // AggregationDateDefinition
//         interval: "year" || "quarter" || "month" || "week" || "day" || "hour" || "minute", // required
//         timeZone: "STRING_VALUE",
//       },
//       dayOfWeek: { // AggregationDayOfWeekDefinition
//         timeZone: "STRING_VALUE",
//       },
//       hourOfDay: {},
//     },
//     buckets: [ // AggregationBucketsList // required
//       { // AggregationBucket
//         key: "STRING_VALUE", // required
//         count: Number("long"), // required
//         aggregation: {
//           aggregation: {//  Union: only one key present
//             projection: {
//               id: "STRING_VALUE", // required
//               fieldId: "STRING_VALUE", // required
//             },
//             direction: {},
//             duration: {
//               buckets: [
//                 {
//                   title: "STRING_VALUE", // required
//                   from: Number("int"),
//                   to: Number("int"),
//                 },
//               ],
//             },
//             service: {},
//             extension: {},
//             group: {},
//             type: {},
//             recorded: {},
//             date: {
//               interval: "year" || "quarter" || "month" || "week" || "day" || "hour" || "minute", // required
//               timeZone: "STRING_VALUE",
//             },
//             dayOfWeek: {
//               timeZone: "STRING_VALUE",
//             },
//             hourOfDay: {},
//           },
//           buckets: [ // required
//             {
//               key: "STRING_VALUE", // required
//               count: Number("long"), // required
//               aggregation: "<AggregationResult>",
//             },
//           ],
//         },
//       },
//     ],
//   },
// };