ExStreamClient.Operations.Chat.Stats (ExStreamClient v0.2.0)

Copy Markdown View Source

Modules for interacting with the chat/stats group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Shared options

All functions in this module accept the following optional parameters:

  • api_key - API key to use. If not provided, the default key from config will be used
  • authenticate_as_user - User id to authenticate. If not provided, the server key will be used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

Types

shared_opts()

Functions

query_team_usage_stats(payload, opts \\ [])

Retrieve team-level usage statistics from the warehouse database. Returns all 16 metrics grouped by team with cursor-based pagination.

Types

shared_opts()

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  authenticate_as_user: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

Functions

query_team_usage_stats(payload, opts \\ [])

@spec query_team_usage_stats(
  ExStreamClient.Model.QueryTeamUsageStatsRequest.t(),
  shared_opts()
) ::
  {:ok, ExStreamClient.Model.QueryTeamUsageStatsResponse.t()} | {:error, any()}

Retrieve team-level usage statistics from the warehouse database. Returns all 16 metrics grouped by team with cursor-based pagination.

Date Range Options (mutually exclusive):

  • Use 'month' parameter (YYYY-MM format) for monthly aggregated values
  • Use 'start_date'/'end_date' parameters (YYYY-MM-DD format) for daily breakdown
  • If neither provided, defaults to current month (monthly mode)

This endpoint is server-side only.

Required Arguments:

Optional Arguments: