Sha256: 958aa900e3ea6c15bc94fffa82c6b88de1357a13b9318f932d1e53510b4d6ccc
Contents?: true
Size: 1.69 KB
Versions: 11
Compression:
Stored size: 1.69 KB
Contents
---
title: FlowsApi
---
## PureCloud::FlowsApi
All URIs are relative to *https://api.mypurecloud.com*
Method | Description
------------- | ------------- | -------------
[**post_analytics_flows_aggregates_query**](FlowsApi.html#post_analytics_flows_aggregates_query) | Query for flow aggregates
{: class="table table-striped"}
<a name="post_analytics_flows_aggregates_query"></a>
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_flows_aggregates_query(body)
Query for flow aggregates
Wraps POST /api/v2/analytics/flows/aggregates/query
Requires ANY permissions:
* analytics:flowAggregate:view
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
PureCloud.configure do |config|
config.access_token = @authToken
end
api_instance = PureCloud::FlowsApi.new
body = PureCloud::AggregationQuery.new # AggregationQuery | query
begin
#Query for flow aggregates
result = api_instance.post_analytics_flows_aggregates_query(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FlowsApi->post_analytics_flows_aggregates_query: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AggregationQuery**](AggregationQuery.html)| query | |
{: class="table table-striped"}
### Return type
[**AggregateQueryResponse**](AggregateQueryResponse.html)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Version data entries
11 entries across 11 versions & 1 rubygems