Package software.xdev.brevo.model

Class GetCampaignStats

java.lang.Object
software.xdev.brevo.model.GetCampaignStats
public class GetCampaignStats extends Object
GetCampaignStats

  • Field Details

  • Constructor Details

    • GetCampaignStats

      public GetCampaignStats()

  • Method Details

    • listId

      public GetCampaignStats listId(@Nullable Long listId)

    • getListId

      @Nullable public Long getListId()
      List Id of email campaign (only in case of get email campaign(s)(not for global stats))
      Returns:
      listId

    • setListId

      public void setListId(@Nullable Long listId)

    • uniqueClicks

      public GetCampaignStats uniqueClicks(@Nonnull Long uniqueClicks)

    • getUniqueClicks

      @Nonnull public Long getUniqueClicks()
      Number of unique clicks for the campaign
      Returns:
      uniqueClicks

    • setUniqueClicks

      public void setUniqueClicks(@Nonnull Long uniqueClicks)

    • clickers

      public GetCampaignStats clickers(@Nonnull Long clickers)

    • getClickers

      @Nonnull public Long getClickers()
      Number of total clicks for the campaign
      Returns:
      clickers

    • setClickers

      public void setClickers(@Nonnull Long clickers)

    • complaints

      public GetCampaignStats complaints(@Nonnull Long complaints)

    • getComplaints

      @Nonnull public Long getComplaints()
      Number of complaints (Spam reports) for the campaign
      Returns:
      complaints

    • setComplaints

      public void setComplaints(@Nonnull Long complaints)

    • delivered

      public GetCampaignStats delivered(@Nonnull Long delivered)

    • getDelivered

      @Nonnull public Long getDelivered()
      Number of delivered emails for the campaign
      Returns:
      delivered

    • setDelivered

      public void setDelivered(@Nonnull Long delivered)

    • sent

      public GetCampaignStats sent(@Nonnull Long sent)

    • getSent

      @Nonnull public Long getSent()
      Number of sent emails for the campaign
      Returns:
      sent

    • setSent

      public void setSent(@Nonnull Long sent)

    • softBounces

      public GetCampaignStats softBounces(@Nonnull Long softBounces)

    • getSoftBounces

      @Nonnull public Long getSoftBounces()
      Number of softbounce for the campaign
      Returns:
      softBounces

    • setSoftBounces

      public void setSoftBounces(@Nonnull Long softBounces)

    • hardBounces

      public GetCampaignStats hardBounces(@Nonnull Long hardBounces)

    • getHardBounces

      @Nonnull public Long getHardBounces()
      Number of harbounce for the campaign
      Returns:
      hardBounces

    • setHardBounces

      public void setHardBounces(@Nonnull Long hardBounces)

    • uniqueViews

      public GetCampaignStats uniqueViews(@Nonnull Long uniqueViews)

    • getUniqueViews

      @Nonnull public Long getUniqueViews()
      Number of unique openings for the campaign
      Returns:
      uniqueViews

    • setUniqueViews

      public void setUniqueViews(@Nonnull Long uniqueViews)

    • trackableViews

      public GetCampaignStats trackableViews(@Nonnull Long trackableViews)

    • getTrackableViews

      @Nonnull public Long getTrackableViews()
      Recipients without any privacy protection option enabled in their email client
      Returns:
      trackableViews

    • setTrackableViews

      public void setTrackableViews(@Nonnull Long trackableViews)

    • trackableViewsRate

      public GetCampaignStats trackableViewsRate(@Nullable Float trackableViewsRate)

    • getTrackableViewsRate

      @Nullable public Float getTrackableViewsRate()
      Rate of recipients without any privacy protection option enabled in their email client
      Returns:
      trackableViewsRate

    • setTrackableViewsRate

      public void setTrackableViewsRate(@Nullable Float trackableViewsRate)

    • estimatedViews

      public GetCampaignStats estimatedViews(@Nullable Long estimatedViews)

    • getEstimatedViews

      @Nullable public Long getEstimatedViews()
      Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails
      Returns:
      estimatedViews

    • setEstimatedViews

      public void setEstimatedViews(@Nullable Long estimatedViews)

    • unsubscriptions

      public GetCampaignStats unsubscriptions(@Nonnull Long unsubscriptions)

    • getUnsubscriptions

      @Nonnull public Long getUnsubscriptions()
      Number of unsubscription for the campaign
      Returns:
      unsubscriptions

    • setUnsubscriptions

      public void setUnsubscriptions(@Nonnull Long unsubscriptions)

    • viewed

      public GetCampaignStats viewed(@Nonnull Long viewed)

    • getViewed

      @Nonnull public Long getViewed()
      Number of openings for the campaign
      Returns:
      viewed

    • setViewed

      public void setViewed(@Nonnull Long viewed)

    • deferred

      public GetCampaignStats deferred(@Nullable Long deferred)

    • getDeferred

      @Nullable public Long getDeferred()
      Number of deferred emails for the campaign
      Returns:
      deferred

    • setDeferred

      public void setDeferred(@Nullable Long deferred)

    • returnBounce

      public GetCampaignStats returnBounce(@Nullable Long returnBounce)

    • getReturnBounce

      @Nullable public Long getReturnBounce()
      Total number of non-delivered campaigns for a particular campaign id.
      Returns:
      returnBounce

    • setReturnBounce

      public void setReturnBounce(@Nullable Long returnBounce)

    • opensRate

      public GetCampaignStats opensRate(@Nullable Float opensRate)

    • getOpensRate

      @Nullable public Float getOpensRate()
      Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens.
      Returns:
      opensRate

    • setOpensRate

      public void setOpensRate(@Nullable Float opensRate)

    • appleMppOpens

      public GetCampaignStats appleMppOpens(@Nullable Long appleMppOpens)

    • getAppleMppOpens

      @Nullable public Long getAppleMppOpens()
      Numbers of times your email has been opened automatically through Apple MPP.
      Returns:
      appleMppOpens

    • setAppleMppOpens

      public void setAppleMppOpens(@Nullable Long appleMppOpens)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string