# NOTE: This file is auto generated by OpenAPI Generator 6.1.1-SNAPSHOT (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule BrazeEx.Api.ExportSessionAnalytics do
@moduledoc """
API calls for all endpoints tagged `ExportSessionAnalytics`.
"""
alias BrazeEx.Connection
import BrazeEx.RequestBuilder
@doc """
## App Sessions by Time
This endpoint allows you to retrieve a series of the number of sessions for your app over a designated time period.
## Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in [API rate limits](https://www.braze.com/docs/api/api_limits/).
## Response
``` json
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"data" : [
{
"time" : (string) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"sessions" : (int)
},
...
]
}
```
### Parameters
- `connection` (BrazeEx.Connection): Connection to server
- `opts` (keyword): Optional parameters
- `:authorization` (String.t):
- `:length` (integer()): (Required) Integer Max number of days before `ending_at` to include in the returned series - must be between 1 and 100 (inclusive).
- `:unit` (String.t): (Optional) String Unit of time between data points. Can be `day` or `hour`, defaults to `day`.
- `:ending_at` (String.t): (Optional) Datetime ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string) Date on which the data series should end. Defaults to time of the request.
- `:app_id` (String.t): (Optional) String App API identifier retrieved from the **Developer Console** to limit analytics to a specific app.
- `:segment_id` (String.t): (Required) String See [Segment API identifier](https://www.braze.com/docs/api/identifier_types/). The `segment_id` for a given segment can be found in your **Developer Console** within your Braze account or you can use the [Segment List Endpoint](https://www.braze.com/docs/api/endpoints/export/get_segment/).
### Returns
- `{:ok, nil}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec sessions_data_series_get(Tesla.Env.client(), keyword()) ::
{:ok, nil} | {:error, Tesla.Env.t()}
def sessions_data_series_get(connection, opts \\ []) do
optional_params = %{
:Authorization => :headers,
:length => :query,
:unit => :query,
:ending_at => :query,
:app_id => :query,
:segment_id => :query
}
request =
%{}
|> method(:get)
|> url("/sessions/data_series")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, false}
])
end
end