com.mailgun.api.v3.MailgunStatisticsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mailgun-java Show documentation

The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.

The newest version!

package com.mailgun.api.v3;

import com.mailgun.api.MailgunApi;
import com.mailgun.model.StatisticsOptions;
import com.mailgun.model.stats.StatsResult;
import feign.Headers;
import feign.Param;
import feign.QueryMap;
import feign.RequestLine;
import feign.Response;

/**
 * 
 * Mailgun collects many different events and generates event statistics available via this API.
 * 
 * 
 * This data is also available in your Control Panel.
 * 
 * 
 * The statistics are calculated in hourly, daily and monthly resolution in UTC timezone.
 * 
 *
 * @see Stats
 */
@Headers({"Accept: application/json"})
public interface MailgunStatisticsApi extends MailgunApi {

    /**
     * 
     * Returns total statistics for a given domain.
     * 
     *
     * @param domain            Name of the domain
     * @param statisticsOptions {@link StatisticsOptions}
     * @return {@link StatsResult}
     */
    @RequestLine("GET /{domain}/stats/total")
    StatsResult getDomainStats(@Param("domain") String domain, @QueryMap StatisticsOptions statisticsOptions);

    /**
     * 
     * Returns total statistics for a given domain.
     * 
     *
     * @param domain            Name of the domain
     * @param statisticsOptions {@link StatisticsOptions}
     * @return {@link Response}
     */
    @RequestLine("GET /{domain}/stats/total")
    Response getDomainStatsFeignResponse(@Param("domain") String domain, @QueryMap StatisticsOptions statisticsOptions);

}