Struct Analytics

pub struct Analytics {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Analytics

pub async fn create_report<'a>( &'a self, body: &AnalyticsReportRequest2, ) -> Result<AnalyticsReportResponse2, Error>

Create a new analytics report.

Create a new analytics report for a set of metrics over a specific time span. The report will be executed asynchronously. The response will include a link that can be used to retrieve the report status & result.

async fn example_analytics_create_report() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::AnalyticsReportResponse2 = client
        .analytics()
        .create_report(&serde_json::Value::String("some-string".to_string()))
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_report<'a>( &'a self, report_uid: &'a str, ) -> Result<AnalyticsReportResponse2, Error>

Fetch an analytics report.

Parameters:

• report_uid: &'astr: The report UID. (required)

async fn example_analytics_get_report() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::AnalyticsReportResponse2 =
        client.analytics().get_report("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn create_export<'a>( &'a self, body: &AnalyticsExportRequest2, ) -> Result<AnalyticsExportResponse2, Error>

Create a new analytics export.

Create a new analytics export of messages or activities over a specific time span. The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result.

async fn example_analytics_create_export() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::AnalyticsExportResponse2 = client
        .analytics()
        .create_export(&serde_json::Value::String("some-string".to_string()))
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_export<'a>( &'a self, export_id: &'a str, ) -> Result<AnalyticsExportResponse2, Error>

Fetch an analytics export.

Parameters:

• export_id: &'astr: The export ID. (required)

async fn example_analytics_get_export() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::AnalyticsExportResponse2 =
        client.analytics().get_export("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Analytics

fn clone(&self) -> Analytics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Analytics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.