HookSniffAPI.Api.Analytics (hooksniff v1.0.0)

API calls for all endpoints tagged Analytics.

Summary

Functions

analytics_deliveries_get(connection, opts \\ [])

Delivery trend over time

analytics_latency_get(connection, opts \\ [])

Latency trend over time

analytics_success_rate_get(connection, opts \\ [])

Success rate metrics

Functions

analytics_deliveries_get(connection, opts \\ [])

@spec analytics_deliveries_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.DeliveryTrendResponse.t()} | {:error, Tesla.Env.t()}

Delivery trend over time

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :range (String.t):

Returns

{:ok, HookSniffAPI.Model.DeliveryTrendResponse.t} on success
{:error, Tesla.Env.t} on failure

analytics_latency_get(connection, opts \\ [])

@spec analytics_latency_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.LatencyTrendResponse.t()} | {:error, Tesla.Env.t()}

Latency trend over time

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :range (String.t):

Returns

{:ok, HookSniffAPI.Model.LatencyTrendResponse.t} on success
{:error, Tesla.Env.t} on failure

analytics_success_rate_get(connection, opts \\ [])

@spec analytics_success_rate_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, HookSniffAPI.Model.SuccessRateResponse.t()} | {:error, Tesla.Env.t()}

Success rate metrics

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :range (String.t):

Returns

{:ok, HookSniffAPI.Model.SuccessRateResponse.t} on success
{:error, Tesla.Env.t} on failure