/*
* Linkbreakers API
*
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API's name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
*
* The version of the OpenAPI document: 1.178.0
*
* Generated by: https://openapi-generator.tech
*/
use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};
/// struct for typed errors of method [`analytics_data_service_get_attribute_distribution`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetAttributeDistributionError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_attribute_metric`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetAttributeMetricError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_attribute_values`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetAttributeValuesError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_breakdown`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetBreakdownError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_device_distribution`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetDeviceDistributionError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_geo_breakdown`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetGeoBreakdownError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_grouped_time_series`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetGroupedTimeSeriesError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_hour_of_day_distribution`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetHourOfDayDistributionError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_step_funnel`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetStepFunnelError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_top_links`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetTopLinksError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_data_service_get_visitor_trends`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDataServiceGetVisitorTrendsError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// Returns how visitors are spread across the values of one attribute, for example how many gave each rating. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_attribute_distribution(configuration: &configuration::Configuration, get_attribute_distribution_request: models::GetAttributeDistributionRequest, idempotency_key: Option<&str>) -> Result<models::GetAttributeDistributionResponse, Error<AnalyticsDataServiceGetAttributeDistributionError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_attribute_distribution_request = get_attribute_distribution_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/attributes/distribution", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_attribute_distribution_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetAttributeDistributionResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetAttributeDistributionResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetAttributeDistributionError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_attribute_metric(configuration: &configuration::Configuration, get_attribute_metric_request: models::GetAttributeMetricRequest, idempotency_key: Option<&str>) -> Result<models::GetAttributeMetricResponse, Error<AnalyticsDataServiceGetAttributeMetricError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_attribute_metric_request = get_attribute_metric_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/attributes/metric", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_attribute_metric_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetAttributeMetricResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetAttributeMetricResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetAttributeMetricError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_attribute_values(configuration: &configuration::Configuration, get_attribute_values_request: models::GetAttributeValuesRequest, idempotency_key: Option<&str>) -> Result<models::GetAttributeValuesResponse, Error<AnalyticsDataServiceGetAttributeValuesError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_attribute_values_request = get_attribute_values_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/attributes/values", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_attribute_values_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetAttributeValuesResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetAttributeValuesResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetAttributeValuesError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type). Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_breakdown(configuration: &configuration::Configuration, get_breakdown_request: models::GetBreakdownRequest, idempotency_key: Option<&str>) -> Result<models::GetBreakdownResponse, Error<AnalyticsDataServiceGetBreakdownError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_breakdown_request = get_breakdown_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/breakdown", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_breakdown_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetBreakdownResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetBreakdownResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetBreakdownError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve event distribution across device types. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_device_distribution(configuration: &configuration::Configuration, get_device_distribution_request: models::GetDeviceDistributionRequest, idempotency_key: Option<&str>) -> Result<models::GetDeviceDistributionResponse, Error<AnalyticsDataServiceGetDeviceDistributionError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_device_distribution_request = get_device_distribution_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/devices", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_device_distribution_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetDeviceDistributionResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetDeviceDistributionResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetDeviceDistributionError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve geographic distribution of events grouped by country or city. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_geo_breakdown(configuration: &configuration::Configuration, get_geo_breakdown_request: models::GetGeoBreakdownRequest, idempotency_key: Option<&str>) -> Result<models::GetGeoBreakdownResponse, Error<AnalyticsDataServiceGetGeoBreakdownError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_geo_breakdown_request = get_geo_breakdown_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/geo", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_geo_breakdown_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetGeoBreakdownResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetGeoBreakdownResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetGeoBreakdownError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_grouped_time_series(configuration: &configuration::Configuration, get_grouped_time_series_request: models::GetGroupedTimeSeriesRequest, idempotency_key: Option<&str>) -> Result<models::GetGroupedTimeSeriesResponse, Error<AnalyticsDataServiceGetGroupedTimeSeriesError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_grouped_time_series_request = get_grouped_time_series_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/timeseries", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_grouped_time_series_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetGroupedTimeSeriesResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetGroupedTimeSeriesResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetGroupedTimeSeriesError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve event counts aggregated by hour of day for identifying peak activity times. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_hour_of_day_distribution(configuration: &configuration::Configuration, get_hour_of_day_distribution_request: models::GetHourOfDayDistributionRequest, idempotency_key: Option<&str>) -> Result<models::GetHourOfDayDistributionResponse, Error<AnalyticsDataServiceGetHourOfDayDistributionError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_hour_of_day_distribution_request = get_hour_of_day_distribution_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/hours", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_hour_of_day_distribution_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetHourOfDayDistributionResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetHourOfDayDistributionResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetHourOfDayDistributionError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_step_funnel(configuration: &configuration::Configuration, get_step_funnel_request: models::GetStepFunnelRequest, idempotency_key: Option<&str>) -> Result<models::GetStepFunnelResponse, Error<AnalyticsDataServiceGetStepFunnelError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_step_funnel_request = get_step_funnel_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/funnel", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_step_funnel_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetStepFunnelResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetStepFunnelResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetStepFunnelError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve links ranked by event count for identifying best performing QR codes and links. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_top_links(configuration: &configuration::Configuration, get_top_links_request: models::GetTopLinksRequest, idempotency_key: Option<&str>) -> Result<models::GetTopLinksResponse, Error<AnalyticsDataServiceGetTopLinksError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_top_links_request = get_top_links_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/top-links", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_top_links_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetTopLinksResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetTopLinksResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetTopLinksError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Retrieve new vs returning visitor counts over time. Requires the `analytics:read` scope.
pub async fn analytics_data_service_get_visitor_trends(configuration: &configuration::Configuration, get_visitor_trends_request: models::GetVisitorTrendsRequest, idempotency_key: Option<&str>) -> Result<models::GetVisitorTrendsResponse, Error<AnalyticsDataServiceGetVisitorTrendsError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_get_visitor_trends_request = get_visitor_trends_request;
let p_header_idempotency_key = idempotency_key;
let uri_str = format!("{}/v1/analytics/visitors", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(param_value) = p_header_idempotency_key {
req_builder = req_builder.header("Idempotency-Key", param_value.to_string());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_get_visitor_trends_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetVisitorTrendsResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetVisitorTrendsResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDataServiceGetVisitorTrendsError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}