Gleanex.Client.Insights (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoint related to insights

Summary

Functions

insights(body, opts \\ [])

@spec insights(body :: Gleanex.Client.InsightsRequest.t(), opts :: keyword()) ::
  {:ok, Gleanex.Client.InsightsResponse.t()} | {:error, Gleanex.Error.t()}

Get insights

Gets the aggregate usage insights data displayed in the Insights Dashboards.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

Includes request parameters for insights requests.