getAnalyticEngagementActions
GetAnalyticEngagementActions
No required parameters, DateValue defaults to Today.
/Analytics/EngagementActions/
Usage and SDK Samples
curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/EngagementActions/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;
import java.io.File;
import java.util.*;
public class AnalyticsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
AnalyticsApi apiInstance = new AnalyticsApi();
String reportTag = reportTag_example; // String | Report Tag filter.
String start = start_example; // String | Report start date
String end = end_example; // String | Report end date
String dateValue = dateValue_example; // String | Days spanned by report
String limit = limit_example; // String | Number of records returned from top of response
try {
array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalyticsApi#getAnalyticEngagementActions");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AnalyticsApi;
public class AnalyticsApiExample {
public static void main(String[] args) {
AnalyticsApi apiInstance = new AnalyticsApi();
String reportTag = reportTag_example; // String | Report Tag filter.
String start = start_example; // String | Report start date
String end = end_example; // String | Report end date
String dateValue = dateValue_example; // String | Days spanned by report
String limit = limit_example; // String | Number of records returned from top of response
try {
array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalyticsApi#getAnalyticEngagementActions");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];
String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)
AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];
// GetAnalyticEngagementActions
[apiInstance getAnalyticEngagementActionsWith:reportTag
start:start
end:end
dateValue:dateValue
limit:limit
completionHandler: ^(array[EngagementActionsResponse] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;
// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"
// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"
var api = new EntertainmentExpressApi.AnalyticsApi()
var opts = {
'reportTag': reportTag_example, // {String} Report Tag filter.
'start': start_example, // {String} Report start date
'end': end_example, // {String} Report end date
'dateValue': dateValue_example, // {String} Days spanned by report
'limit': limit_example // {String} Number of records returned from top of response
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAnalyticEngagementActions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAnalyticEngagementActionsExample
{
public void main()
{
// Configure API key authorization: ApiKeyHeader
Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
// Configure API key authorization: ApiKeyQuery
Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");
var apiInstance = new AnalyticsApi();
var reportTag = reportTag_example; // String | Report Tag filter. (optional)
var start = start_example; // String | Report start date (optional)
var end = end_example; // String | Report end date (optional)
var dateValue = dateValue_example; // String | Days spanned by report (optional)
var limit = limit_example; // String | Number of records returned from top of response (optional)
try
{
// GetAnalyticEngagementActions
array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AnalyticsApi.getAnalyticEngagementActions: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');
$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response
try {
$result = $api_instance->getAnalyticEngagementActions($reportTag, $start, $end, $dateValue, $limit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->getAnalyticEngagementActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;
# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";
my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response
eval {
my $result = $api_instance->getAnalyticEngagementActions(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AnalyticsApi->getAnalyticEngagementActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)
try:
# GetAnalyticEngagementActions
api_response = api_instance.get_analytic_engagement_actions(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->getAnalyticEngagementActions: %s\n" % e)
Parameters
Name | Description |
---|---|
ReportTag |
String
Report Tag filter.
|
Start |
String
Report start date
|
End |
String
Report end date
|
DateValue |
String
Days spanned by report
|
Limit |
String
Number of records returned from top of response
|