Contents

---
title: JourneyApi
---

## PureCloud::JourneyApi

All URIs are relative to *https://api.mypurecloud.com*

Method | Description
------------- | ------------- | -------------
[**post_analytics_journeys_aggregates_query**](JourneyApi.html#post_analytics_journeys_aggregates_query) | Query for journey aggregates
{: class="table table-striped"}

<a name="post_analytics_journeys_aggregates_query"></a>

## [**JourneyAggregateQueryResponse**](JourneyAggregateQueryResponse.html) post_analytics_journeys_aggregates_query(body)



Query for journey aggregates



Wraps POST /api/v2/analytics/journeys/aggregates/query 

Requires ANY permissions: 

* analytics:journeyAggregate:view


### Example
```{"language":"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::JourneyApi.new

body = PureCloud::JourneyAggregationQuery.new # JourneyAggregationQuery | query


begin
  #Query for journey aggregates
  result = api_instance.post_analytics_journeys_aggregates_query(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling JourneyApi->post_analytics_journeys_aggregates_query: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**JourneyAggregationQuery**](JourneyAggregationQuery.html)| query |  |
{: class="table table-striped"}


### Return type

[**JourneyAggregateQueryResponse**](JourneyAggregateQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
purecloudplatformclientv2-96.0.0	docs/JourneyApi.md
purecloudplatformclientv2-95.0.0	docs/JourneyApi.md
purecloudplatformclientv2-94.0.0	docs/JourneyApi.md