Class ListSessionAnalyticsDataRequest

    • Method Detail

      • botId

        public final String botId()

        The identifier for the bot for which you want to retrieve session analytics.

        Returns:
        The identifier for the bot for which you want to retrieve session analytics.
      • startDateTime

        public final Instant startDateTime()

        The date and time that marks the beginning of the range of time for which you want to see session analytics.

        Returns:
        The date and time that marks the beginning of the range of time for which you want to see session analytics.
      • endDateTime

        public final Instant endDateTime()

        The date and time that marks the end of the range of time for which you want to see session analytics.

        Returns:
        The date and time that marks the end of the range of time for which you want to see session analytics.
      • sortBy

        public final SessionDataSortBy sortBy()

        An object specifying the measure and method by which to sort the session analytics data.

        Returns:
        An object specifying the measure and method by which to sort the session analytics data.
      • hasFilters

        public final boolean hasFilters()
        For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • filters

        public final List<AnalyticsSessionFilter> filters()

        A list of objects, each of which describes a condition by which you want to filter the results.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

        Returns:
        A list of objects, each of which describes a condition by which you want to filter the results.
      • maxResults

        public final Integer maxResults()

        The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

        Returns:
        The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
      • nextToken

        public final String nextToken()

        If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

        Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

        Returns:
        If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

        Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object