# BehavioralsignalsUapiClient.CampaignsApi

All URIs are relative to *https://uapi1.behavioralsignals.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getCampaigns**](CampaignsApi.md#getCampaigns) | **GET** /aggregator/campaigns/ | Returns a list of campaigns.
[**getCampaignsCampaignId**](CampaignsApi.md#getCampaignsCampaignId) | **GET** /aggregator/campaigns/{campaign_id}/ | Returns details for a campaign.
[**getCampaignsList**](CampaignsApi.md#getCampaignsList) | **GET** /campaigns/ | 


<a name="getCampaigns"></a>
# **getCampaigns**
> ResponseAggregatorCampaigns getCampaigns(opts)

Returns a list of campaigns.

Returns a campaign list

### Example
```javascript
var BehavioralsignalsUapiClient = require('behavioralsignals-uapi-client');
var defaultClient = BehavioralsignalsUapiClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new BehavioralsignalsUapiClient.CampaignsApi();

var opts = { 
  'agentId': "agentId_example", // String | Filter calls based on agent_id and calculate per campaign aggregates
  'sortBy': "size", // String | Sorting option
  'page': 1, // Number | Page number
  'limit': 20, // Number | The maximum size of the page entries
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Aggregates campaigns based on the start of a date range
  'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Aggregates campaigns based on the end of a date range
};
apiInstance.getCampaigns(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **agentId** | **String**| Filter calls based on agent_id and calculate per campaign aggregates | [optional] 
 **sortBy** | **String**| Sorting option | [optional] [default to size]
 **page** | **Number**| Page number | [optional] [default to 1]
 **limit** | **Number**| The maximum size of the page entries | [optional] [default to 20]
 **startDate** | **Date**| Aggregates campaigns based on the start of a date range | [optional] 
 **endDate** | **Date**| Aggregates campaigns based on the end of a date range | [optional] 

### Return type

[**ResponseAggregatorCampaigns**](ResponseAggregatorCampaigns.md)

### Authorization

[OAuth2](../README.md#OAuth2)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, text/csv

<a name="getCampaignsCampaignId"></a>
# **getCampaignsCampaignId**
> Campaign getCampaignsCampaignId(campaignId, opts)

Returns details for a campaign.

Returns details for a campaign.

### Example
```javascript
var BehavioralsignalsUapiClient = require('behavioralsignals-uapi-client');
var defaultClient = BehavioralsignalsUapiClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new BehavioralsignalsUapiClient.CampaignsApi();

var campaignId = "campaignId_example"; // String | The campaign id

var opts = { 
  'agentId': "agentId_example", // String | Filter calls based on agent_id and calculate per campaign aggregates
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Aggregates campaign based on the start of a date range
  'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Aggregates campaign based on the end of a date range
};
apiInstance.getCampaignsCampaignId(campaignId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **campaignId** | **String**| The campaign id | 
 **agentId** | **String**| Filter calls based on agent_id and calculate per campaign aggregates | [optional] 
 **startDate** | **Date**| Aggregates campaign based on the start of a date range | [optional] 
 **endDate** | **Date**| Aggregates campaign based on the end of a date range | [optional] 

### Return type

[**Campaign**](Campaign.md)

### Authorization

[OAuth2](../README.md#OAuth2)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, text/csv

<a name="getCampaignsList"></a>
# **getCampaignsList**
> ResponseCampaignsList getCampaignsList(opts)



Returns a list of campaigns without aggregation

### Example
```javascript
var BehavioralsignalsUapiClient = require('behavioralsignals-uapi-client');
var defaultClient = BehavioralsignalsUapiClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new BehavioralsignalsUapiClient.CampaignsApi();

var opts = { 
  'page': 8.14, // Number | Page number
  'limit': 8.14 // Number | The maximum size of the page entries
};
apiInstance.getCampaignsList(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page** | **Number**| Page number | [optional] 
 **limit** | **Number**| The maximum size of the page entries | [optional] 

### Return type

[**ResponseCampaignsList**](ResponseCampaignsList.md)

### Authorization

[OAuth2](../README.md#OAuth2)

### HTTP request headers

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