ApolloSignal.Domains.Metrics (apollo_signal v1.0.5)

Copy Markdown View Source

metrics API operations.

Summary

Types

t()

@type t() :: %ApolloSignal.Domains.Metrics{client: ApolloSignal.Client.t()}

Functions

get_email_engagement(domain, id, options \\ [])

@spec get_email_engagement(domain :: t(), id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.EmailReadScrollAnalyticsResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_email_performance(domain, id, options \\ [])

@spec get_email_performance(domain :: t(), id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.EmailPerformanceResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_metrics_advisor(domain, query \\ %{}, options \\ [])

@spec get_metrics_advisor(
  domain :: t(),
  query :: ApolloSignal.Types.GetMetricsAdvisorQuery.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.AdvisorReportResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_project_metrics_summary(domain, query \\ %{}, options \\ [])

@spec get_project_metrics_summary(
  domain :: t(),
  query :: ApolloSignal.Types.GetProjectMetricsSummaryQuery.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ProjectMetricsSummaryResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_project_metrics_timeline(domain, query \\ %{}, options \\ [])

@spec get_project_metrics_timeline(
  domain :: t(),
  query :: ApolloSignal.Types.GetProjectMetricsTimelineQuery.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ProjectMetricsTimelineResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_topic_performance(domain, id, query \\ %{}, options \\ [])

@spec get_topic_performance(
  domain :: t(),
  id :: String.t(),
  query :: ApolloSignal.Types.GetTopicPerformanceQuery.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.TopicPerformanceResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

new(client)

@spec new(ApolloSignal.Client.t()) :: t()