Interface IStatsResource

Namespace

Mailtrap.Stats

Assembly

Mailtrap.Abstractions.dll

Represents sending statistics resource.

public interface IStatsResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

ByCategory(StatsFilter, CancellationToken)

Gets sending statistics grouped by categories.

Task<IList<SendingStatGroup>> ByCategory(StatsFilter filter, CancellationToken cancellationToken = default)

Parameters

filter StatsFilter

Filter parameters for the stats period.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<SendingStatGroup>>

Collection of sending statistics grouped by category.

ByDate(StatsFilter, CancellationToken)

Gets sending statistics grouped by date.

Task<IList<SendingStatGroup>> ByDate(StatsFilter filter, CancellationToken cancellationToken = default)

Parameters

filter StatsFilter

Filter parameters for the stats period.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<SendingStatGroup>>

Collection of sending statistics grouped by date.

ByDomain(StatsFilter, CancellationToken)

Gets sending statistics grouped by sending domains.

Task<IList<SendingStatGroup>> ByDomain(StatsFilter filter, CancellationToken cancellationToken = default)

Parameters

filter StatsFilter

Filter parameters for the stats period.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<SendingStatGroup>>

Collection of sending statistics grouped by sending domain.

ByEmailServiceProvider(StatsFilter, CancellationToken)

Gets sending statistics grouped by email service providers.

Task<IList<SendingStatGroup>> ByEmailServiceProvider(StatsFilter filter, CancellationToken cancellationToken = default)

Parameters

filter StatsFilter

Filter parameters for the stats period.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<SendingStatGroup>>

Collection of sending statistics grouped by email service provider.

GetStats(StatsFilter, CancellationToken)

Gets aggregated sending statistics.

Task<SendingStats> GetStats(StatsFilter filter, CancellationToken cancellationToken = default)

Parameters

filter StatsFilter

Filter parameters for the stats period.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<SendingStats>

Aggregated sending statistics.