Struct sendgrid_api::categories::Categories

pub struct Categories {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Categories

pub async fn get_page(
    &self,
    limit: i64,
    category: &str,
    offset: i64
) -> Result<Vec<GetCategoriesResponse>>

Retrieve all categories.

This function performs a GET to the /categories endpoint.

This endpoint allows you to retrieve a list of all of your categories.

Parameters:

• limit: i64 – The number of categories to display per page.
• category: &str – Allows you to perform a prefix search on this particular category.
• offset: i64 – The point in the list that you would like to begin displaying results.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_all(
    &self,
    limit: i64,
    category: &str,
    offset: i64
) -> Result<Vec<GetCategoriesResponse>>

Retrieve all categories.

This function performs a GET to the /categories endpoint.

As opposed to get, this function returns all the pages of the request at once.

This endpoint allows you to retrieve a list of all of your categories.

pub async fn get_stats_sum(
    &self,
    sort_by_metric: &str,
    sort_by_direction: SortByDirection,
    start_date: &str,
    end_date: &str,
    limit: i64,
    offset: i64,
    aggregated_by: TraitStatsAdvancedBaseQueryStringsAggregatedBy
) -> Result<CategoryStats>

Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?].

This function performs a GET to the /categories/stats/sums endpoint.

This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Parameters:

• sort_by_metric: &str – The metric that you want to sort by. Must be a single metric.
• sort_by_direction: crate::types::SortByDirection – The direction you want to sort.
• start_date: &str – The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
• end_date: &str – The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
• limit: i64 – Limits the number of results returned.
• offset: i64 – The point in the list to begin retrieving results.
• aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy – How to group the statistics. Must be either “day”, “week”, or “month”.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_stats(
    &self,
    start_date: &str,
    end_date: &str,
    categories: &str,
    limit: i64,
    offset: i64,
    aggregated_by: TraitStatsAdvancedBaseQueryStringsAggregatedBy
) -> Result<Vec<CategoryStats>>

Retrieve Email Statistics for Categories.

This function performs a GET to the /categories/stats endpoint.

This endpoint allows you to retrieve all of your email statistics for each of your categories.

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Parameters:

• start_date: &str – The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
• end_date: &str – The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
• categories: &str – The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.
• limit: i64 – The number of results to include.
• offset: i64 – The number of results to skip.
• aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy – How to group the statistics. Must be either “day”, “week”, or “month”.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_all_stats(
    &self,
    start_date: &str,
    end_date: &str,
    categories: &str,
    limit: i64,
    offset: i64,
    aggregated_by: TraitStatsAdvancedBaseQueryStringsAggregatedBy
) -> Result<Vec<CategoryStats>>

Retrieve Email Statistics for Categories.

This function performs a GET to the /categories/stats endpoint.

As opposed to get_stats, this function returns all the pages of the request at once.

This endpoint allows you to retrieve all of your email statistics for each of your categories.

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.