Cloverleaf Search API

Default

getMeetingTranscripts

Get all transcripts from a single meeting. If the transcript has a verified speaker, it can be found in the "person" property. The person data will have either a person_id or a contact_id. Having a person_id indicates that the contact was generated via transcript data and having a contact_id indicates that the contact was generated via 3rd party data.


/search/meeting/{meeting_id}/transcripts

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}/transcripts"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

        try {
            array[Transcript] result = apiInstance.getMeetingTranscripts(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getMeetingTranscripts");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to obtain transcripts from.

try {
    final result = await api_instance.getMeetingTranscripts(meetingId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getMeetingTranscripts: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

        try {
            array[Transcript] result = apiInstance.getMeetingTranscripts(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getMeetingTranscripts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to obtain transcripts from. (default to null)

[apiInstance getMeetingTranscriptsWith:meetingId
              completionHandler: ^(array[Transcript] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to obtain transcripts from.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMeetingTranscripts(meetingId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMeetingTranscriptsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to obtain transcripts from. (default to null)

            try {
                array[Transcript] result = apiInstance.getMeetingTranscripts(meetingId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.getMeetingTranscripts: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

try {
    $result = $api_instance->getMeetingTranscripts($meetingId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getMeetingTranscripts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to obtain transcripts from.

eval {
    my $result = $api_instance->getMeetingTranscripts(meetingId => $meetingId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getMeetingTranscripts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to obtain transcripts from. (default to null)

try:
    api_response = api_instance.get_meeting_transcripts(meetingId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getMeetingTranscripts: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.getMeetingTranscripts(meetingId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to obtain transcripts from.
Required

Responses

getMeetingTranscriptsV2


/search/meeting/{meeting_id}/transcripts_v2

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}/transcripts_v2"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

        try {
            MeetingTranscriptsV2Response result = apiInstance.getMeetingTranscriptsV2(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getMeetingTranscriptsV2");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to obtain transcripts from.

try {
    final result = await api_instance.getMeetingTranscriptsV2(meetingId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getMeetingTranscriptsV2: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

        try {
            MeetingTranscriptsV2Response result = apiInstance.getMeetingTranscriptsV2(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getMeetingTranscriptsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to obtain transcripts from. (default to null)

[apiInstance getMeetingTranscriptsV2With:meetingId
              completionHandler: ^(MeetingTranscriptsV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to obtain transcripts from.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMeetingTranscriptsV2(meetingId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMeetingTranscriptsV2Example
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to obtain transcripts from. (default to null)

            try {
                MeetingTranscriptsV2Response result = apiInstance.getMeetingTranscriptsV2(meetingId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.getMeetingTranscriptsV2: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to obtain transcripts from.

try {
    $result = $api_instance->getMeetingTranscriptsV2($meetingId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getMeetingTranscriptsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to obtain transcripts from.

eval {
    my $result = $api_instance->getMeetingTranscriptsV2(meetingId => $meetingId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getMeetingTranscriptsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to obtain transcripts from. (default to null)

try:
    api_response = api_instance.get_meeting_transcripts_v2(meetingId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getMeetingTranscriptsV2: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.getMeetingTranscriptsV2(meetingId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to obtain transcripts from.
Required

Responses

ping


/ping

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/ping"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();

        try {
            'String' result = apiInstance.ping();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#ping");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.ping();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->ping: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();

        try {
            'String' result = apiInstance.ping();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#ping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pingWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ping(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pingExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();

            try {
                'String' result = apiInstance.ping();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.ping: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();

try {
    $result = $api_instance->ping();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->ping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();

eval {
    my $result = $api_instance->ping();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->ping: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()

try:
    api_response = api_instance.ping()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ping: %s\n" % e)
extern crate DefaultApi;

pub fn main() {

    let mut context = DefaultApi::Context::default();
    let result = client.ping(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

searchByCampaignId


/search/campaigns/{campaign_id}

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/campaigns/{campaign_id}?date-range="

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float campaignId = 3.4; // Float | 
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.

        try {
            SearchResult result = apiInstance.searchByCampaignId(campaignId, dateRange);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchByCampaignId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float campaignId = new Float(); // Float | 
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.

try {
    final result = await api_instance.searchByCampaignId(campaignId, dateRange);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchByCampaignId: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float campaignId = 3.4; // Float | 
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.

        try {
            SearchResult result = apiInstance.searchByCampaignId(campaignId, dateRange);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchByCampaignId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *campaignId = 3.4; //  (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)

[apiInstance searchByCampaignIdWith:campaignId
    dateRange:dateRange
              completionHandler: ^(SearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var campaignId = 3.4; // {Float} 
var opts = {
  'dateRange':  // {array[Float]} An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchByCampaignId(campaignId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchByCampaignIdExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var campaignId = 3.4;  // Float |  (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional)  (default to null)

            try {
                SearchResult result = apiInstance.searchByCampaignId(campaignId, dateRange);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchByCampaignId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$campaignId = 3.4; // Float | 
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.

try {
    $result = $api_instance->searchByCampaignId($campaignId, $dateRange);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchByCampaignId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $campaignId = 3.4; # Float | 
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.

eval {
    my $result = $api_instance->searchByCampaignId(campaignId => $campaignId, dateRange => $dateRange);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchByCampaignId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
campaignId = 3.4 # Float |  (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)

try:
    api_response = api_instance.search_by_campaign_id(campaignId, dateRange=dateRange)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchByCampaignId: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let campaignId = 3.4; // Float
    let dateRange = ; // array[Float]

    let mut context = DefaultApi::Context::default();
    let result = client.searchByCampaignId(campaignId, dateRange, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
campaign_id*
Float (float)
Required
Query parameters
Name Description
date-range
array[Float] (float)
An array of 2 integers indicating the start and end time of the search. The integers should correspond to milliseconds since January 1st 1970.

Responses

searchCampaigns


/search/campaigns

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/campaigns"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();

        try {
            array[Campaign] result = apiInstance.searchCampaigns();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchCampaigns");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.searchCampaigns();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchCampaigns: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();

        try {
            array[Campaign] result = apiInstance.searchCampaigns();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchCampaigns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance searchCampaignsWithCompletionHandler: 
              ^(array[Campaign] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCampaigns(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchCampaignsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();

            try {
                array[Campaign] result = apiInstance.searchCampaigns();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchCampaigns: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();

try {
    $result = $api_instance->searchCampaigns();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();

eval {
    my $result = $api_instance->searchCampaigns();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchCampaigns: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()

try:
    api_response = api_instance.search_campaigns()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchCampaigns: %s\n" % e)
extern crate DefaultApi;

pub fn main() {

    let mut context = DefaultApi::Context::default();
    let result = client.searchCampaigns(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

searchContacts


/search/contacts

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/contacts?organization_id=3.4&offset=3.4&limit=3.4&city_name=cityName_example&county_name=countyName_example&state_name=stateName_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float organizationId = 3.4; // Float | Get all contacts that are under this organization id.
        Float offset = 3.4; // Float | Integer specifying the offset for where to srart returning reuslts
        Float limit = 3.4; // Float | The limit of how many results to return.
        String cityName = cityName_example; // String | Filter contacts by city name. Supports multiple values separated by commas.
        String countyName = countyName_example; // String | Filter contacts by county name. Supports multiple values separated by commas.
        String stateName = stateName_example; // String | Filter contacts by state name. Supports multiple values separated by commas.

        try {
            array[Contact] result = apiInstance.searchContacts(organizationId, offset, limit, cityName, countyName, stateName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchContacts");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float organizationId = new Float(); // Float | Get all contacts that are under this organization id.
final Float offset = new Float(); // Float | Integer specifying the offset for where to srart returning reuslts
final Float limit = new Float(); // Float | The limit of how many results to return.
final String cityName = new String(); // String | Filter contacts by city name. Supports multiple values separated by commas.
final String countyName = new String(); // String | Filter contacts by county name. Supports multiple values separated by commas.
final String stateName = new String(); // String | Filter contacts by state name. Supports multiple values separated by commas.

try {
    final result = await api_instance.searchContacts(organizationId, offset, limit, cityName, countyName, stateName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchContacts: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float organizationId = 3.4; // Float | Get all contacts that are under this organization id.
        Float offset = 3.4; // Float | Integer specifying the offset for where to srart returning reuslts
        Float limit = 3.4; // Float | The limit of how many results to return.
        String cityName = cityName_example; // String | Filter contacts by city name. Supports multiple values separated by commas.
        String countyName = countyName_example; // String | Filter contacts by county name. Supports multiple values separated by commas.
        String stateName = stateName_example; // String | Filter contacts by state name. Supports multiple values separated by commas.

        try {
            array[Contact] result = apiInstance.searchContacts(organizationId, offset, limit, cityName, countyName, stateName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchContacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *organizationId = 3.4; // Get all contacts that are under this organization id. (default to null)
Float *offset = 3.4; // Integer specifying the offset for where to srart returning reuslts (default to null)
Float *limit = 3.4; // The limit of how many results to return. (default to null)
String *cityName = cityName_example; // Filter contacts by city name. Supports multiple values separated by commas. (optional) (default to null)
String *countyName = countyName_example; // Filter contacts by county name. Supports multiple values separated by commas. (optional) (default to null)
String *stateName = stateName_example; // Filter contacts by state name. Supports multiple values separated by commas. (optional) (default to null)

[apiInstance searchContactsWith:organizationId
    offset:offset
    limit:limit
    cityName:cityName
    countyName:countyName
    stateName:stateName
              completionHandler: ^(array[Contact] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var organizationId = 3.4; // {Float} Get all contacts that are under this organization id.
var offset = 3.4; // {Float} Integer specifying the offset for where to srart returning reuslts
var limit = 3.4; // {Float} The limit of how many results to return.
var opts = {
  'cityName': cityName_example, // {String} Filter contacts by city name. Supports multiple values separated by commas.
  'countyName': countyName_example, // {String} Filter contacts by county name. Supports multiple values separated by commas.
  'stateName': stateName_example // {String} Filter contacts by state name. Supports multiple values separated by commas.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchContacts(organizationId, offset, limit, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchContactsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var organizationId = 3.4;  // Float | Get all contacts that are under this organization id. (default to null)
            var offset = 3.4;  // Float | Integer specifying the offset for where to srart returning reuslts (default to null)
            var limit = 3.4;  // Float | The limit of how many results to return. (default to null)
            var cityName = cityName_example;  // String | Filter contacts by city name. Supports multiple values separated by commas. (optional)  (default to null)
            var countyName = countyName_example;  // String | Filter contacts by county name. Supports multiple values separated by commas. (optional)  (default to null)
            var stateName = stateName_example;  // String | Filter contacts by state name. Supports multiple values separated by commas. (optional)  (default to null)

            try {
                array[Contact] result = apiInstance.searchContacts(organizationId, offset, limit, cityName, countyName, stateName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchContacts: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$organizationId = 3.4; // Float | Get all contacts that are under this organization id.
$offset = 3.4; // Float | Integer specifying the offset for where to srart returning reuslts
$limit = 3.4; // Float | The limit of how many results to return.
$cityName = cityName_example; // String | Filter contacts by city name. Supports multiple values separated by commas.
$countyName = countyName_example; // String | Filter contacts by county name. Supports multiple values separated by commas.
$stateName = stateName_example; // String | Filter contacts by state name. Supports multiple values separated by commas.

try {
    $result = $api_instance->searchContacts($organizationId, $offset, $limit, $cityName, $countyName, $stateName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $organizationId = 3.4; # Float | Get all contacts that are under this organization id.
my $offset = 3.4; # Float | Integer specifying the offset for where to srart returning reuslts
my $limit = 3.4; # Float | The limit of how many results to return.
my $cityName = cityName_example; # String | Filter contacts by city name. Supports multiple values separated by commas.
my $countyName = countyName_example; # String | Filter contacts by county name. Supports multiple values separated by commas.
my $stateName = stateName_example; # String | Filter contacts by state name. Supports multiple values separated by commas.

eval {
    my $result = $api_instance->searchContacts(organizationId => $organizationId, offset => $offset, limit => $limit, cityName => $cityName, countyName => $countyName, stateName => $stateName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchContacts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
organizationId = 3.4 # Float | Get all contacts that are under this organization id. (default to null)
offset = 3.4 # Float | Integer specifying the offset for where to srart returning reuslts (default to null)
limit = 3.4 # Float | The limit of how many results to return. (default to null)
cityName = cityName_example # String | Filter contacts by city name. Supports multiple values separated by commas. (optional) (default to null)
countyName = countyName_example # String | Filter contacts by county name. Supports multiple values separated by commas. (optional) (default to null)
stateName = stateName_example # String | Filter contacts by state name. Supports multiple values separated by commas. (optional) (default to null)

try:
    api_response = api_instance.search_contacts(organizationId, offset, limit, cityName=cityName, countyName=countyName, stateName=stateName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchContacts: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let organizationId = 3.4; // Float
    let offset = 3.4; // Float
    let limit = 3.4; // Float
    let cityName = cityName_example; // String
    let countyName = countyName_example; // String
    let stateName = stateName_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.searchContacts(organizationId, offset, limit, cityName, countyName, stateName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
organization_id*
Float (float)
Get all contacts that are under this organization id.
Required
offset*
Float (float)
Integer specifying the offset for where to srart returning reuslts
Required
limit*
Float (float)
The limit of how many results to return.
Required
city_name
String
Filter contacts by city name. Supports multiple values separated by commas.
county_name
String
Filter contacts by county name. Supports multiple values separated by commas.
state_name
String
Filter contacts by state name. Supports multiple values separated by commas.

Responses

searchHits

Get number of hits for a single term


/search/hits

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/hits?terms=terms_example&filter-params=filterParams_example&date-range=&use-territory=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String terms = terms_example; // String | Term that you want a count for.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Boolean useTerritory = true; // Boolean | When true, scope the count to the authenticated user's territory channels.

        try {
            Float result = apiInstance.searchHits(terms, filterParams, dateRange, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchHits");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String terms = new String(); // String | Term that you want a count for.
final String filterParams = new String(); // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
final Boolean useTerritory = new Boolean(); // Boolean | When true, scope the count to the authenticated user's territory channels.

try {
    final result = await api_instance.searchHits(terms, filterParams, dateRange, useTerritory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchHits: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String terms = terms_example; // String | Term that you want a count for.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Boolean useTerritory = true; // Boolean | When true, scope the count to the authenticated user's territory channels.

        try {
            Float result = apiInstance.searchHits(terms, filterParams, dateRange, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchHits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *terms = terms_example; // Term that you want a count for. (default to null)
String *filterParams = filterParams_example; // Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
Boolean *useTerritory = true; // When true, scope the count to the authenticated user's territory channels. (optional) (default to null)

[apiInstance searchHitsWith:terms
    filterParams:filterParams
    dateRange:dateRange
    useTerritory:useTerritory
              completionHandler: ^(Float output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var terms = terms_example; // {String} Term that you want a count for.
var filterParams = filterParams_example; // {String} Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
var opts = {
  'dateRange': , // {array[Float]} An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
  'useTerritory': true // {Boolean} When true, scope the count to the authenticated user's territory channels.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchHits(terms, filterParams, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchHitsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var terms = terms_example;  // String | Term that you want a count for. (default to null)
            var filterParams = filterParams_example;  // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional)  (default to null)
            var useTerritory = true;  // Boolean | When true, scope the count to the authenticated user's territory channels. (optional)  (default to null)

            try {
                Float result = apiInstance.searchHits(terms, filterParams, dateRange, useTerritory);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchHits: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$terms = terms_example; // String | Term that you want a count for.
$filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
$useTerritory = true; // Boolean | When true, scope the count to the authenticated user's territory channels.

try {
    $result = $api_instance->searchHits($terms, $filterParams, $dateRange, $useTerritory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchHits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $terms = terms_example; # String | Term that you want a count for.
my $filterParams = filterParams_example; # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
my $useTerritory = true; # Boolean | When true, scope the count to the authenticated user's territory channels.

eval {
    my $result = $api_instance->searchHits(terms => $terms, filterParams => $filterParams, dateRange => $dateRange, useTerritory => $useTerritory);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchHits: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
terms = terms_example # String | Term that you want a count for. (default to null)
filterParams = filterParams_example # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
useTerritory = true # Boolean | When true, scope the count to the authenticated user's territory channels. (optional) (default to null)

try:
    api_response = api_instance.search_hits(terms, filterParams, dateRange=dateRange, useTerritory=useTerritory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchHits: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let terms = terms_example; // String
    let filterParams = filterParams_example; // String
    let dateRange = ; // array[Float]
    let useTerritory = true; // Boolean

    let mut context = DefaultApi::Context::default();
    let result = client.searchHits(terms, filterParams, dateRange, useTerritory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
terms*
String
Term that you want a count for.
Required
filter-params*
String
Base64 encoded object containing filter parameters. The original object may have keys "states", "counties", "cities", "channel_types", and "organizations".
Required
date-range
array[Float] (float)
An array of 2 integers indicating the start and end time of the search. The integers should correspond to milliseconds since January 1st 1970.
use-territory
Boolean
When true, scope the count to the authenticated user's territory channels.

Responses

searchHitsOverTime

Get hits per geography over time


/search/hits-over-time

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/hits-over-time?search-terms=&must-include-terms=&filter-params=filterParams_example&date-range=&time-unit=timeUnit_example&geography-type=geographyType_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[String] mustIncludeTerms = ; // array[String] | List of terms that must be in the meeting.
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        String timeUnit = timeUnit_example; // String | The time unit to group by. One of "day", "week", or "month".
        String geographyType = geographyType_example; // String | The time unit to group by. One of "city", "county", or "state".

        try {
            HitsOverTime result = apiInstance.searchHitsOverTime(searchTerms, filterParams, mustIncludeTerms, dateRange, timeUnit, geographyType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchHitsOverTime");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[String] searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting.
final String filterParams = new String(); // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
final array[String] mustIncludeTerms = new array[String](); // array[String] | List of terms that must be in the meeting.
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
final String timeUnit = new String(); // String | The time unit to group by. One of "day", "week", or "month".
final String geographyType = new String(); // String | The time unit to group by. One of "city", "county", or "state".

try {
    final result = await api_instance.searchHitsOverTime(searchTerms, filterParams, mustIncludeTerms, dateRange, timeUnit, geographyType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchHitsOverTime: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[String] mustIncludeTerms = ; // array[String] | List of terms that must be in the meeting.
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        String timeUnit = timeUnit_example; // String | The time unit to group by. One of "day", "week", or "month".
        String geographyType = geographyType_example; // String | The time unit to group by. One of "city", "county", or "state".

        try {
            HitsOverTime result = apiInstance.searchHitsOverTime(searchTerms, filterParams, mustIncludeTerms, dateRange, timeUnit, geographyType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchHitsOverTime");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
array[String] *searchTerms = ; // List of terms that should be in the meeting. (default to null)
String *filterParams = filterParams_example; // Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
array[String] *mustIncludeTerms = ; // List of terms that must be in the meeting. (optional) (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
String *timeUnit = timeUnit_example; // The time unit to group by. One of "day", "week", or "month". (optional) (default to null)
String *geographyType = geographyType_example; // The time unit to group by. One of "city", "county", or "state". (optional) (default to null)

[apiInstance searchHitsOverTimeWith:searchTerms
    filterParams:filterParams
    mustIncludeTerms:mustIncludeTerms
    dateRange:dateRange
    timeUnit:timeUnit
    geographyType:geographyType
              completionHandler: ^(HitsOverTime output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var searchTerms = ; // {array[String]} List of terms that should be in the meeting.
var filterParams = filterParams_example; // {String} Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
var opts = {
  'mustIncludeTerms': , // {array[String]} List of terms that must be in the meeting.
  'dateRange': , // {array[Float]} An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
  'timeUnit': timeUnit_example, // {String} The time unit to group by. One of "day", "week", or "month".
  'geographyType': geographyType_example // {String} The time unit to group by. One of "city", "county", or "state".
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchHitsOverTime(searchTerms, filterParams, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchHitsOverTimeExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting. (default to null)
            var filterParams = filterParams_example;  // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
            var mustIncludeTerms = new array[String](); // array[String] | List of terms that must be in the meeting. (optional)  (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional)  (default to null)
            var timeUnit = timeUnit_example;  // String | The time unit to group by. One of "day", "week", or "month". (optional)  (default to null)
            var geographyType = geographyType_example;  // String | The time unit to group by. One of "city", "county", or "state". (optional)  (default to null)

            try {
                HitsOverTime result = apiInstance.searchHitsOverTime(searchTerms, filterParams, mustIncludeTerms, dateRange, timeUnit, geographyType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchHitsOverTime: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$searchTerms = ; // array[String] | List of terms that should be in the meeting.
$filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
$mustIncludeTerms = ; // array[String] | List of terms that must be in the meeting.
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
$timeUnit = timeUnit_example; // String | The time unit to group by. One of "day", "week", or "month".
$geographyType = geographyType_example; // String | The time unit to group by. One of "city", "county", or "state".

try {
    $result = $api_instance->searchHitsOverTime($searchTerms, $filterParams, $mustIncludeTerms, $dateRange, $timeUnit, $geographyType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchHitsOverTime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $searchTerms = []; # array[String] | List of terms that should be in the meeting.
my $filterParams = filterParams_example; # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
my $mustIncludeTerms = []; # array[String] | List of terms that must be in the meeting.
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
my $timeUnit = timeUnit_example; # String | The time unit to group by. One of "day", "week", or "month".
my $geographyType = geographyType_example; # String | The time unit to group by. One of "city", "county", or "state".

eval {
    my $result = $api_instance->searchHitsOverTime(searchTerms => $searchTerms, filterParams => $filterParams, mustIncludeTerms => $mustIncludeTerms, dateRange => $dateRange, timeUnit => $timeUnit, geographyType => $geographyType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchHitsOverTime: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
searchTerms =  # array[String] | List of terms that should be in the meeting. (default to null)
filterParams = filterParams_example # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
mustIncludeTerms =  # array[String] | List of terms that must be in the meeting. (optional) (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
timeUnit = timeUnit_example # String | The time unit to group by. One of "day", "week", or "month". (optional) (default to null)
geographyType = geographyType_example # String | The time unit to group by. One of "city", "county", or "state". (optional) (default to null)

try:
    api_response = api_instance.search_hits_over_time(searchTerms, filterParams, mustIncludeTerms=mustIncludeTerms, dateRange=dateRange, timeUnit=timeUnit, geographyType=geographyType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchHitsOverTime: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let searchTerms = ; // array[String]
    let filterParams = filterParams_example; // String
    let mustIncludeTerms = ; // array[String]
    let dateRange = ; // array[Float]
    let timeUnit = timeUnit_example; // String
    let geographyType = geographyType_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.searchHitsOverTime(searchTerms, filterParams, mustIncludeTerms, dateRange, timeUnit, geographyType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search-terms*
array[String]
List of terms that should be in the meeting.
Required
must-include-terms
array[String]
List of terms that must be in the meeting.
filter-params*
String
Base64 encoded object containing filter parameters. The original object may have keys "states", "counties", "cities", "channel_types", and "organizations".
Required
date-range
array[Float] (float)
An array of 2 integers indicating the start and end time of the search. The integers should correspond to milliseconds since January 1st 1970.
time-unit
String
The time unit to group by. One of "day", "week", or "month".
geography-type
String
The time unit to group by. One of "city", "county", or "state".

Responses

searchMeetingBuffered

Search for transcripts matching keywords within a single meeting and return buffered clips — time ranges that extend `buffer` seconds before and after each hit. Overlapping buffer ranges are merged into a single clip. Each transcript within a clip is marked with `is_hit` to distinguish keyword matches from surrounding context.


/search/meeting/{meeting_id}/buffered

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}/buffered?search-terms=&buffer=3.4&voice-ids=&title-search-terms=&organization-search-terms=&proximity=3.4&must-have-terms=&exclude=exclude_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        Float buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
        array[Float] voiceIds = ; // array[Float] | Filter transcripts by voice IDs.
        array[String] titleSearchTerms = ; // array[String] | Filter transcripts by speaker title keywords.
        array[String] organizationSearchTerms = ; // array[String] | Filter transcripts by speaker organization keywords.
        Float proximity = 3.4; // Float | Number of seconds that filters transcript results based on proximity.
        array[String] mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
        String exclude = exclude_example; // String | Set to "true" to exclude proximity matches instead of including them.

        try {
            BufferedMeetingSearchResult result = apiInstance.searchMeetingBuffered(meetingId, searchTerms, buffer, voiceIds, titleSearchTerms, organizationSearchTerms, proximity, mustHaveTerms, exclude);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingBuffered");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to search within.
final array[String] searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting.
final Float buffer = new Float(); // Float | Buffer in seconds to extend before and after each hit transcript.
final array[Float] voiceIds = new array[Float](); // array[Float] | Filter transcripts by voice IDs.
final array[String] titleSearchTerms = new array[String](); // array[String] | Filter transcripts by speaker title keywords.
final array[String] organizationSearchTerms = new array[String](); // array[String] | Filter transcripts by speaker organization keywords.
final Float proximity = new Float(); // Float | Number of seconds that filters transcript results based on proximity.
final array[String] mustHaveTerms = new array[String](); // array[String] | List of terms that must be in the meeting.
final String exclude = new String(); // String | Set to "true" to exclude proximity matches instead of including them.

try {
    final result = await api_instance.searchMeetingBuffered(meetingId, searchTerms, buffer, voiceIds, titleSearchTerms, organizationSearchTerms, proximity, mustHaveTerms, exclude);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchMeetingBuffered: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        Float buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
        array[Float] voiceIds = ; // array[Float] | Filter transcripts by voice IDs.
        array[String] titleSearchTerms = ; // array[String] | Filter transcripts by speaker title keywords.
        array[String] organizationSearchTerms = ; // array[String] | Filter transcripts by speaker organization keywords.
        Float proximity = 3.4; // Float | Number of seconds that filters transcript results based on proximity.
        array[String] mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
        String exclude = exclude_example; // String | Set to "true" to exclude proximity matches instead of including them.

        try {
            BufferedMeetingSearchResult result = apiInstance.searchMeetingBuffered(meetingId, searchTerms, buffer, voiceIds, titleSearchTerms, organizationSearchTerms, proximity, mustHaveTerms, exclude);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingBuffered");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to search within. (default to null)
array[String] *searchTerms = ; // List of terms that should be in the meeting. (default to null)
Float *buffer = 3.4; // Buffer in seconds to extend before and after each hit transcript. (default to null)
array[Float] *voiceIds = ; // Filter transcripts by voice IDs. (optional) (default to null)
array[String] *titleSearchTerms = ; // Filter transcripts by speaker title keywords. (optional) (default to null)
array[String] *organizationSearchTerms = ; // Filter transcripts by speaker organization keywords. (optional) (default to null)
Float *proximity = 3.4; // Number of seconds that filters transcript results based on proximity. (optional) (default to null)
array[String] *mustHaveTerms = ; // List of terms that must be in the meeting. (optional) (default to null)
String *exclude = exclude_example; // Set to "true" to exclude proximity matches instead of including them. (optional) (default to null)

[apiInstance searchMeetingBufferedWith:meetingId
    searchTerms:searchTerms
    buffer:buffer
    voiceIds:voiceIds
    titleSearchTerms:titleSearchTerms
    organizationSearchTerms:organizationSearchTerms
    proximity:proximity
    mustHaveTerms:mustHaveTerms
    exclude:exclude
              completionHandler: ^(BufferedMeetingSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to search within.
var searchTerms = ; // {array[String]} List of terms that should be in the meeting.
var buffer = 3.4; // {Float} Buffer in seconds to extend before and after each hit transcript.
var opts = {
  'voiceIds': , // {array[Float]} Filter transcripts by voice IDs.
  'titleSearchTerms': , // {array[String]} Filter transcripts by speaker title keywords.
  'organizationSearchTerms': , // {array[String]} Filter transcripts by speaker organization keywords.
  'proximity': 3.4, // {Float} Number of seconds that filters transcript results based on proximity.
  'mustHaveTerms': , // {array[String]} List of terms that must be in the meeting.
  'exclude': exclude_example // {String} Set to "true" to exclude proximity matches instead of including them.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMeetingBuffered(meetingId, searchTerms, buffer, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchMeetingBufferedExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to search within. (default to null)
            var searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting. (default to null)
            var buffer = 3.4;  // Float | Buffer in seconds to extend before and after each hit transcript. (default to null)
            var voiceIds = new array[Float](); // array[Float] | Filter transcripts by voice IDs. (optional)  (default to null)
            var titleSearchTerms = new array[String](); // array[String] | Filter transcripts by speaker title keywords. (optional)  (default to null)
            var organizationSearchTerms = new array[String](); // array[String] | Filter transcripts by speaker organization keywords. (optional)  (default to null)
            var proximity = 3.4;  // Float | Number of seconds that filters transcript results based on proximity. (optional)  (default to null)
            var mustHaveTerms = new array[String](); // array[String] | List of terms that must be in the meeting. (optional)  (default to null)
            var exclude = exclude_example;  // String | Set to "true" to exclude proximity matches instead of including them. (optional)  (default to null)

            try {
                BufferedMeetingSearchResult result = apiInstance.searchMeetingBuffered(meetingId, searchTerms, buffer, voiceIds, titleSearchTerms, organizationSearchTerms, proximity, mustHaveTerms, exclude);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchMeetingBuffered: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to search within.
$searchTerms = ; // array[String] | List of terms that should be in the meeting.
$buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
$voiceIds = ; // array[Float] | Filter transcripts by voice IDs.
$titleSearchTerms = ; // array[String] | Filter transcripts by speaker title keywords.
$organizationSearchTerms = ; // array[String] | Filter transcripts by speaker organization keywords.
$proximity = 3.4; // Float | Number of seconds that filters transcript results based on proximity.
$mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
$exclude = exclude_example; // String | Set to "true" to exclude proximity matches instead of including them.

try {
    $result = $api_instance->searchMeetingBuffered($meetingId, $searchTerms, $buffer, $voiceIds, $titleSearchTerms, $organizationSearchTerms, $proximity, $mustHaveTerms, $exclude);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchMeetingBuffered: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to search within.
my $searchTerms = []; # array[String] | List of terms that should be in the meeting.
my $buffer = 3.4; # Float | Buffer in seconds to extend before and after each hit transcript.
my $voiceIds = []; # array[Float] | Filter transcripts by voice IDs.
my $titleSearchTerms = []; # array[String] | Filter transcripts by speaker title keywords.
my $organizationSearchTerms = []; # array[String] | Filter transcripts by speaker organization keywords.
my $proximity = 3.4; # Float | Number of seconds that filters transcript results based on proximity.
my $mustHaveTerms = []; # array[String] | List of terms that must be in the meeting.
my $exclude = exclude_example; # String | Set to "true" to exclude proximity matches instead of including them.

eval {
    my $result = $api_instance->searchMeetingBuffered(meetingId => $meetingId, searchTerms => $searchTerms, buffer => $buffer, voiceIds => $voiceIds, titleSearchTerms => $titleSearchTerms, organizationSearchTerms => $organizationSearchTerms, proximity => $proximity, mustHaveTerms => $mustHaveTerms, exclude => $exclude);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchMeetingBuffered: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to search within. (default to null)
searchTerms =  # array[String] | List of terms that should be in the meeting. (default to null)
buffer = 3.4 # Float | Buffer in seconds to extend before and after each hit transcript. (default to null)
voiceIds =  # array[Float] | Filter transcripts by voice IDs. (optional) (default to null)
titleSearchTerms =  # array[String] | Filter transcripts by speaker title keywords. (optional) (default to null)
organizationSearchTerms =  # array[String] | Filter transcripts by speaker organization keywords. (optional) (default to null)
proximity = 3.4 # Float | Number of seconds that filters transcript results based on proximity. (optional) (default to null)
mustHaveTerms =  # array[String] | List of terms that must be in the meeting. (optional) (default to null)
exclude = exclude_example # String | Set to "true" to exclude proximity matches instead of including them. (optional) (default to null)

try:
    api_response = api_instance.search_meeting_buffered(meetingId, searchTerms, buffer, voiceIds=voiceIds, titleSearchTerms=titleSearchTerms, organizationSearchTerms=organizationSearchTerms, proximity=proximity, mustHaveTerms=mustHaveTerms, exclude=exclude)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchMeetingBuffered: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float
    let searchTerms = ; // array[String]
    let buffer = 3.4; // Float
    let voiceIds = ; // array[Float]
    let titleSearchTerms = ; // array[String]
    let organizationSearchTerms = ; // array[String]
    let proximity = 3.4; // Float
    let mustHaveTerms = ; // array[String]
    let exclude = exclude_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.searchMeetingBuffered(meetingId, searchTerms, buffer, voiceIds, titleSearchTerms, organizationSearchTerms, proximity, mustHaveTerms, exclude, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to search within.
Required
Query parameters
Name Description
search-terms*
array[String]
List of terms that should be in the meeting.
Required
buffer*
Float (float)
Buffer in seconds to extend before and after each hit transcript.
Required
voice-ids
array[Float] (float)
Filter transcripts by voice IDs.
title-search-terms
array[String]
Filter transcripts by speaker title keywords.
organization-search-terms
array[String]
Filter transcripts by speaker organization keywords.
proximity
Float (float)
Number of seconds that filters transcript results based on proximity.
must-have-terms
array[String]
List of terms that must be in the meeting.
exclude
String
Set to "true" to exclude proximity matches instead of including them.

Responses

searchMeetingById

Get relevant transcripts for terms in a single meeting.


/search/meeting/{meeting_id}

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}?search-terms=&must-have-terms=&proximity=3.4"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        array[String] mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
        Float proximity = 3.4; // Float | Number of seconds that filters transcript results based.

        try {
            MeetingSearchResult result = apiInstance.searchMeetingById(meetingId, searchTerms, mustHaveTerms, proximity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingById");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to search within.
final array[String] searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting.
final array[String] mustHaveTerms = new array[String](); // array[String] | List of terms that must be in the meeting.
final Float proximity = new Float(); // Float | Number of seconds that filters transcript results based.

try {
    final result = await api_instance.searchMeetingById(meetingId, searchTerms, mustHaveTerms, proximity);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchMeetingById: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] searchTerms = ; // array[String] | List of terms that should be in the meeting.
        array[String] mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
        Float proximity = 3.4; // Float | Number of seconds that filters transcript results based.

        try {
            MeetingSearchResult result = apiInstance.searchMeetingById(meetingId, searchTerms, mustHaveTerms, proximity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to search within. (default to null)
array[String] *searchTerms = ; // List of terms that should be in the meeting. (default to null)
array[String] *mustHaveTerms = ; // List of terms that must be in the meeting. (optional) (default to null)
Float *proximity = 3.4; // Number of seconds that filters transcript results based. (optional) (default to null)

[apiInstance searchMeetingByIdWith:meetingId
    searchTerms:searchTerms
    mustHaveTerms:mustHaveTerms
    proximity:proximity
              completionHandler: ^(MeetingSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to search within.
var searchTerms = ; // {array[String]} List of terms that should be in the meeting.
var opts = {
  'mustHaveTerms': , // {array[String]} List of terms that must be in the meeting.
  'proximity': 3.4 // {Float} Number of seconds that filters transcript results based.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMeetingById(meetingId, searchTerms, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchMeetingByIdExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to search within. (default to null)
            var searchTerms = new array[String](); // array[String] | List of terms that should be in the meeting. (default to null)
            var mustHaveTerms = new array[String](); // array[String] | List of terms that must be in the meeting. (optional)  (default to null)
            var proximity = 3.4;  // Float | Number of seconds that filters transcript results based. (optional)  (default to null)

            try {
                MeetingSearchResult result = apiInstance.searchMeetingById(meetingId, searchTerms, mustHaveTerms, proximity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchMeetingById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to search within.
$searchTerms = ; // array[String] | List of terms that should be in the meeting.
$mustHaveTerms = ; // array[String] | List of terms that must be in the meeting.
$proximity = 3.4; // Float | Number of seconds that filters transcript results based.

try {
    $result = $api_instance->searchMeetingById($meetingId, $searchTerms, $mustHaveTerms, $proximity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchMeetingById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to search within.
my $searchTerms = []; # array[String] | List of terms that should be in the meeting.
my $mustHaveTerms = []; # array[String] | List of terms that must be in the meeting.
my $proximity = 3.4; # Float | Number of seconds that filters transcript results based.

eval {
    my $result = $api_instance->searchMeetingById(meetingId => $meetingId, searchTerms => $searchTerms, mustHaveTerms => $mustHaveTerms, proximity => $proximity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchMeetingById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to search within. (default to null)
searchTerms =  # array[String] | List of terms that should be in the meeting. (default to null)
mustHaveTerms =  # array[String] | List of terms that must be in the meeting. (optional) (default to null)
proximity = 3.4 # Float | Number of seconds that filters transcript results based. (optional) (default to null)

try:
    api_response = api_instance.search_meeting_by_id(meetingId, searchTerms, mustHaveTerms=mustHaveTerms, proximity=proximity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchMeetingById: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float
    let searchTerms = ; // array[String]
    let mustHaveTerms = ; // array[String]
    let proximity = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.searchMeetingById(meetingId, searchTerms, mustHaveTerms, proximity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to search within.
Required
Query parameters
Name Description
search-terms*
array[String]
List of terms that should be in the meeting.
Required
must-have-terms
array[String]
List of terms that must be in the meeting.
proximity
Float (float)
Number of seconds that filters transcript results based.

Responses

searchMeetingDocumentsNls

Natural-language search over meeting/legislation document embeddings. Embeds the user's query via the internal Octen 8B service and runs a kNN search against the document embedding index. Hits are grouped by document and returned in best-score (relevance) order with a server-side similarity floor.


/search/meeting-documents/nls

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting-documents/nls?nls-query=nlsQuery_example&filter-params=filterParams_example&index-name=indexName_example&date-range=&page=3.4&per-page=3.4&k=3.4&meeting-document-ids=&use-territory=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
        String indexName = indexName_example; // String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
        Float page = 3.4; // Float | Which page of document hits to return.
        Float perPage = 3.4; // Float | Number of document hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
        array[Float] meetingDocumentIds = ; // array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
        Boolean useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

        try {
            DocumentNlsSearchResult result = apiInstance.searchMeetingDocumentsNls(nlsQuery, filterParams, indexName, dateRange, page, perPage, k, meetingDocumentIds, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingDocumentsNls");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nlsQuery = new String(); // String | The natural-language query to embed and search.
final String filterParams = new String(); // String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
final String indexName = new String(); // String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
final Float page = new Float(); // Float | Which page of document hits to return.
final Float perPage = new Float(); // Float | Number of document hits per page.
final Float k = new Float(); // Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
final array[Float] meetingDocumentIds = new array[Float](); // array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
final Boolean useTerritory = new Boolean(); // Boolean | When true, scope the search to the authenticated user's territory channels.

try {
    final result = await api_instance.searchMeetingDocumentsNls(nlsQuery, filterParams, indexName, dateRange, page, perPage, k, meetingDocumentIds, useTerritory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchMeetingDocumentsNls: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
        String indexName = indexName_example; // String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
        Float page = 3.4; // Float | Which page of document hits to return.
        Float perPage = 3.4; // Float | Number of document hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
        array[Float] meetingDocumentIds = ; // array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
        Boolean useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

        try {
            DocumentNlsSearchResult result = apiInstance.searchMeetingDocumentsNls(nlsQuery, filterParams, indexName, dateRange, page, perPage, k, meetingDocumentIds, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingDocumentsNls");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *nlsQuery = nlsQuery_example; // The natural-language query to embed and search. (default to null)
String *filterParams = filterParams_example; // Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources". (default to null)
String *indexName = indexName_example; // Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both. (optional) (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970. (optional) (default to null)
Float *page = 3.4; // Which page of document hits to return. (optional) (default to null)
Float *perPage = 3.4; // Number of document hits per page. (optional) (default to null)
Float *k = 3.4; // Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side. (optional) (default to null)
array[Float] *meetingDocumentIds = ; // Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping. (optional) (default to null)
Boolean *useTerritory = true; // When true, scope the search to the authenticated user's territory channels. (optional) (default to null)

[apiInstance searchMeetingDocumentsNlsWith:nlsQuery
    filterParams:filterParams
    indexName:indexName
    dateRange:dateRange
    page:page
    perPage:perPage
    k:k
    meetingDocumentIds:meetingDocumentIds
    useTerritory:useTerritory
              completionHandler: ^(DocumentNlsSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var nlsQuery = nlsQuery_example; // {String} The natural-language query to embed and search.
var filterParams = filterParams_example; // {String} Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
var opts = {
  'indexName': indexName_example, // {String} Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
  'dateRange': , // {array[Float]} An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
  'page': 3.4, // {Float} Which page of document hits to return.
  'perPage': 3.4, // {Float} Number of document hits per page.
  'k': 3.4, // {Float} Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
  'meetingDocumentIds': , // {array[Float]} Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
  'useTerritory': true // {Boolean} When true, scope the search to the authenticated user's territory channels.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMeetingDocumentsNls(nlsQuery, filterParams, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchMeetingDocumentsNlsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var nlsQuery = nlsQuery_example;  // String | The natural-language query to embed and search. (default to null)
            var filterParams = filterParams_example;  // String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources". (default to null)
            var indexName = indexName_example;  // String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both. (optional)  (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970. (optional)  (default to null)
            var page = 3.4;  // Float | Which page of document hits to return. (optional)  (default to null)
            var perPage = 3.4;  // Float | Number of document hits per page. (optional)  (default to null)
            var k = 3.4;  // Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side. (optional)  (default to null)
            var meetingDocumentIds = new array[Float](); // array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping. (optional)  (default to null)
            var useTerritory = true;  // Boolean | When true, scope the search to the authenticated user's territory channels. (optional)  (default to null)

            try {
                DocumentNlsSearchResult result = apiInstance.searchMeetingDocumentsNls(nlsQuery, filterParams, indexName, dateRange, page, perPage, k, meetingDocumentIds, useTerritory);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchMeetingDocumentsNls: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
$filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
$indexName = indexName_example; // String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
$page = 3.4; // Float | Which page of document hits to return.
$perPage = 3.4; // Float | Number of document hits per page.
$k = 3.4; // Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
$meetingDocumentIds = ; // array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
$useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

try {
    $result = $api_instance->searchMeetingDocumentsNls($nlsQuery, $filterParams, $indexName, $dateRange, $page, $perPage, $k, $meetingDocumentIds, $useTerritory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchMeetingDocumentsNls: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $nlsQuery = nlsQuery_example; # String | The natural-language query to embed and search.
my $filterParams = filterParams_example; # String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources".
my $indexName = indexName_example; # String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both.
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970.
my $page = 3.4; # Float | Which page of document hits to return.
my $perPage = 3.4; # Float | Number of document hits per page.
my $k = 3.4; # Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side.
my $meetingDocumentIds = []; # array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping.
my $useTerritory = true; # Boolean | When true, scope the search to the authenticated user's territory channels.

eval {
    my $result = $api_instance->searchMeetingDocumentsNls(nlsQuery => $nlsQuery, filterParams => $filterParams, indexName => $indexName, dateRange => $dateRange, page => $page, perPage => $perPage, k => $k, meetingDocumentIds => $meetingDocumentIds, useTerritory => $useTerritory);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchMeetingDocumentsNls: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
nlsQuery = nlsQuery_example # String | The natural-language query to embed and search. (default to null)
filterParams = filterParams_example # String | Base64 encoded object containing filter parameters. The original
object may have keys "states", "counties", "cities", "channel_types",
"organizations", "legislative_bodies", "document_types", and "sources". (default to null)
indexName = indexName_example # String | Scopes results by document_type, mirroring keyword search:
"legislation-documents" (legislative types), "meeting-documents"
(agenda/minutes/etc.), or omitted to search both. (optional) (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end of the search,
in milliseconds since January 1st 1970. (optional) (default to null)
page = 3.4 # Float | Which page of document hits to return. (optional) (default to null)
perPage = 3.4 # Float | Number of document hits per page. (optional) (default to null)
k = 3.4 # Float | Number of nearest-neighbor chunk hits to retrieve from Elasticsearch
before grouping by document and paginating. Capped server-side. (optional) (default to null)
meetingDocumentIds =  # array[Float] | Optional explicit document-id scope. When provided, restricts NLS
results to these meeting_document_ids before grouping. (optional) (default to null)
useTerritory = true # Boolean | When true, scope the search to the authenticated user's territory channels. (optional) (default to null)

try:
    api_response = api_instance.search_meeting_documents_nls(nlsQuery, filterParams, indexName=indexName, dateRange=dateRange, page=page, perPage=perPage, k=k, meetingDocumentIds=meetingDocumentIds, useTerritory=useTerritory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchMeetingDocumentsNls: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let nlsQuery = nlsQuery_example; // String
    let filterParams = filterParams_example; // String
    let indexName = indexName_example; // String
    let dateRange = ; // array[Float]
    let page = 3.4; // Float
    let perPage = 3.4; // Float
    let k = 3.4; // Float
    let meetingDocumentIds = ; // array[Float]
    let useTerritory = true; // Boolean

    let mut context = DefaultApi::Context::default();
    let result = client.searchMeetingDocumentsNls(nlsQuery, filterParams, indexName, dateRange, page, perPage, k, meetingDocumentIds, useTerritory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
nls-query*
String
The natural-language query to embed and search.
Required
filter-params*
String
Base64 encoded object containing filter parameters. The original object may have keys "states", "counties", "cities", "channel_types", "organizations", "legislative_bodies", "document_types", and "sources".
Required
index-name
String
Scopes results by document_type, mirroring keyword search: "legislation-documents" (legislative types), "meeting-documents" (agenda/minutes/etc.), or omitted to search both.
date-range
array[Float] (float)
An array of 2 integers indicating the start and end of the search, in milliseconds since January 1st 1970.
page
Float (float)
Which page of document hits to return.
per-page
Float (float)
Number of document hits per page.
k
Float (float)
Number of nearest-neighbor chunk hits to retrieve from Elasticsearch before grouping by document and paginating. Capped server-side.
meeting-document-ids
array[Float] (float)
Optional explicit document-id scope. When provided, restricts NLS results to these meeting_document_ids before grouping.
use-territory
Boolean
When true, scope the search to the authenticated user's territory channels.

Responses

searchMeetingNlsBuffered

Natural-language search with buffered clips. Accepts one or more `nls-query` parameters, batch-embeds them, runs kNN per query, then extends each hit by `buffer` seconds in both directions, merges overlapping ranges, and returns grouped clips per query with surrounding transcript context.


/search/meeting/{meeting_id}/nls/buffered

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}/nls/buffered?nls-query=&buffer=3.4&k=3.4"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] nlsQuery = ; // array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
        Float buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.

        try {
            NlsBufferedMeetingSearchResult result = apiInstance.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingNlsBuffered");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to search within.
final array[String] nlsQuery = new array[String](); // array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
final Float buffer = new Float(); // Float | Buffer in seconds to extend before and after each hit transcript.
final Float k = new Float(); // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.

try {
    final result = await api_instance.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, k);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchMeetingNlsBuffered: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        array[String] nlsQuery = ; // array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
        Float buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.

        try {
            NlsBufferedMeetingSearchResult result = apiInstance.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingNlsBuffered");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to search within. (default to null)
array[String] *nlsQuery = ; // One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries. (default to null)
Float *buffer = 3.4; // Buffer in seconds to extend before and after each hit transcript. (default to null)
Float *k = 3.4; // Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side. (optional) (default to null)

[apiInstance searchMeetingNlsBufferedWith:meetingId
    nlsQuery:nlsQuery
    buffer:buffer
    k:k
              completionHandler: ^(NlsBufferedMeetingSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to search within.
var nlsQuery = ; // {array[String]} One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
var buffer = 3.4; // {Float} Buffer in seconds to extend before and after each hit transcript.
var opts = {
  'k': 3.4 // {Float} Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchMeetingNlsBufferedExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to search within. (default to null)
            var nlsQuery = new array[String](); // array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries. (default to null)
            var buffer = 3.4;  // Float | Buffer in seconds to extend before and after each hit transcript. (default to null)
            var k = 3.4;  // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side. (optional)  (default to null)

            try {
                NlsBufferedMeetingSearchResult result = apiInstance.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, k);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchMeetingNlsBuffered: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to search within.
$nlsQuery = ; // array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
$buffer = 3.4; // Float | Buffer in seconds to extend before and after each hit transcript.
$k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.

try {
    $result = $api_instance->searchMeetingNlsBuffered($meetingId, $nlsQuery, $buffer, $k);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchMeetingNlsBuffered: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to search within.
my $nlsQuery = []; # array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries.
my $buffer = 3.4; # Float | Buffer in seconds to extend before and after each hit transcript.
my $k = 3.4; # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side.

eval {
    my $result = $api_instance->searchMeetingNlsBuffered(meetingId => $meetingId, nlsQuery => $nlsQuery, buffer => $buffer, k => $k);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchMeetingNlsBuffered: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to search within. (default to null)
nlsQuery =  # array[String] | One or more natural-language queries to embed and search.
Repeat the parameter for multiple queries. (default to null)
buffer = 3.4 # Float | Buffer in seconds to extend before and after each hit transcript. (default to null)
k = 3.4 # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch per query before similarity filtering. Capped
server-side. (optional) (default to null)

try:
    api_response = api_instance.search_meeting_nls_buffered(meetingId, nlsQuery, buffer, k=k)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchMeetingNlsBuffered: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float
    let nlsQuery = ; // array[String]
    let buffer = 3.4; // Float
    let k = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.searchMeetingNlsBuffered(meetingId, nlsQuery, buffer, k, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to search within.
Required
Query parameters
Name Description
nls-query*
array[String]
One or more natural-language queries to embed and search. Repeat the parameter for multiple queries.
Required
buffer*
Float (float)
Buffer in seconds to extend before and after each hit transcript.
Required
k
Float (float)
Number of nearest-neighbor transcript hits to retrieve from Elasticsearch per query before similarity filtering. Capped server-side.

Responses

searchMeetingNlsById

Natural-language search over transcript embeddings scoped to a single meeting. Embeds the user's query via the internal Octen 8B service and runs a kNN search filtered to the given `meeting_id` against the transcript embedding index. Hits are returned in best-score (relevance) order with a server-side similarity floor applied; the response omits `terms` and speaker enrichment (an embedding chunk can span multiple speakers).


/search/meeting/{meeting_id}/nls

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/meeting/{meeting_id}/nls?nls-query=nlsQuery_example&k=3.4"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.

        try {
            MeetingNlsSearchResult result = apiInstance.searchMeetingNlsById(meetingId, nlsQuery, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingNlsById");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | Meeting you want to search within.
final String nlsQuery = new String(); // String | The natural-language query to embed and search.
final Float k = new Float(); // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.

try {
    final result = await api_instance.searchMeetingNlsById(meetingId, nlsQuery, k);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchMeetingNlsById: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | Meeting you want to search within.
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.

        try {
            MeetingNlsSearchResult result = apiInstance.searchMeetingNlsById(meetingId, nlsQuery, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchMeetingNlsById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; // Meeting you want to search within. (default to null)
String *nlsQuery = nlsQuery_example; // The natural-language query to embed and search. (default to null)
Float *k = 3.4; // Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side. (optional) (default to null)

[apiInstance searchMeetingNlsByIdWith:meetingId
    nlsQuery:nlsQuery
    k:k
              completionHandler: ^(MeetingNlsSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} Meeting you want to search within.
var nlsQuery = nlsQuery_example; // {String} The natural-language query to embed and search.
var opts = {
  'k': 3.4 // {Float} Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMeetingNlsById(meetingId, nlsQuery, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchMeetingNlsByIdExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float | Meeting you want to search within. (default to null)
            var nlsQuery = nlsQuery_example;  // String | The natural-language query to embed and search. (default to null)
            var k = 3.4;  // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side. (optional)  (default to null)

            try {
                MeetingNlsSearchResult result = apiInstance.searchMeetingNlsById(meetingId, nlsQuery, k);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchMeetingNlsById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | Meeting you want to search within.
$nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
$k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.

try {
    $result = $api_instance->searchMeetingNlsById($meetingId, $nlsQuery, $k);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchMeetingNlsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | Meeting you want to search within.
my $nlsQuery = nlsQuery_example; # String | The natural-language query to embed and search.
my $k = 3.4; # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side.

eval {
    my $result = $api_instance->searchMeetingNlsById(meetingId => $meetingId, nlsQuery => $nlsQuery, k => $k);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchMeetingNlsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float | Meeting you want to search within. (default to null)
nlsQuery = nlsQuery_example # String | The natural-language query to embed and search. (default to null)
k = 3.4 # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before similarity filtering. Capped server-side. (optional) (default to null)

try:
    api_response = api_instance.search_meeting_nls_by_id(meetingId, nlsQuery, k=k)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchMeetingNlsById: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float
    let nlsQuery = nlsQuery_example; // String
    let k = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.searchMeetingNlsById(meetingId, nlsQuery, k, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Meeting you want to search within.
Required
Query parameters
Name Description
nls-query*
String
The natural-language query to embed and search.
Required
k
Float (float)
Number of nearest-neighbor transcript hits to retrieve from Elasticsearch before similarity filtering. Capped server-side.

Responses

searchNls

Natural-language search over transcript embeddings. Embeds the user's query via the internal Octen 8B service and runs a kNN search against the transcript embedding index. Filters (geography, demographics, organizations) are honored via the same `filter-params` shape as /search.


/search/nls

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/nls?nls-query=nlsQuery_example&filter-params=filterParams_example&date-range=&page=3.4&per-page=3.4&k=3.4&use-territory=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Float page = 3.4; // Float | Which page of meeting hits to return.
        Float perPage = 3.4; // Float | Number of meeting hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
        Boolean useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

        try {
            SearchResult result = apiInstance.searchNls(nlsQuery, filterParams, dateRange, page, perPage, k, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchNls");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nlsQuery = new String(); // String | The natural-language query to embed and search.
final String filterParams = new String(); // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
final Float page = new Float(); // Float | Which page of meeting hits to return.
final Float perPage = new Float(); // Float | Number of meeting hits per page.
final Float k = new Float(); // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
final Boolean useTerritory = new Boolean(); // Boolean | When true, scope the search to the authenticated user's territory channels.

try {
    final result = await api_instance.searchNls(nlsQuery, filterParams, dateRange, page, perPage, k, useTerritory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchNls: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
        String filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Float page = 3.4; // Float | Which page of meeting hits to return.
        Float perPage = 3.4; // Float | Number of meeting hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
        Boolean useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

        try {
            SearchResult result = apiInstance.searchNls(nlsQuery, filterParams, dateRange, page, perPage, k, useTerritory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchNls");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *nlsQuery = nlsQuery_example; // The natural-language query to embed and search. (default to null)
String *filterParams = filterParams_example; // Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
Float *page = 3.4; // Which page of meeting hits to return. (optional) (default to null)
Float *perPage = 3.4; // Number of meeting hits per page. (optional) (default to null)
Float *k = 3.4; // Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side. (optional) (default to null)
Boolean *useTerritory = true; // When true, scope the search to the authenticated user's territory channels. (optional) (default to null)

[apiInstance searchNlsWith:nlsQuery
    filterParams:filterParams
    dateRange:dateRange
    page:page
    perPage:perPage
    k:k
    useTerritory:useTerritory
              completionHandler: ^(SearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var nlsQuery = nlsQuery_example; // {String} The natural-language query to embed and search.
var filterParams = filterParams_example; // {String} Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
var opts = {
  'dateRange': , // {array[Float]} An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
  'page': 3.4, // {Float} Which page of meeting hits to return.
  'perPage': 3.4, // {Float} Number of meeting hits per page.
  'k': 3.4, // {Float} Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
  'useTerritory': true // {Boolean} When true, scope the search to the authenticated user's territory channels.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchNls(nlsQuery, filterParams, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchNlsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var nlsQuery = nlsQuery_example;  // String | The natural-language query to embed and search. (default to null)
            var filterParams = filterParams_example;  // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional)  (default to null)
            var page = 3.4;  // Float | Which page of meeting hits to return. (optional)  (default to null)
            var perPage = 3.4;  // Float | Number of meeting hits per page. (optional)  (default to null)
            var k = 3.4;  // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side. (optional)  (default to null)
            var useTerritory = true;  // Boolean | When true, scope the search to the authenticated user's territory channels. (optional)  (default to null)

            try {
                SearchResult result = apiInstance.searchNls(nlsQuery, filterParams, dateRange, page, perPage, k, useTerritory);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchNls: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$nlsQuery = nlsQuery_example; // String | The natural-language query to embed and search.
$filterParams = filterParams_example; // String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
$page = 3.4; // Float | Which page of meeting hits to return.
$perPage = 3.4; // Float | Number of meeting hits per page.
$k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
$useTerritory = true; // Boolean | When true, scope the search to the authenticated user's territory channels.

try {
    $result = $api_instance->searchNls($nlsQuery, $filterParams, $dateRange, $page, $perPage, $k, $useTerritory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchNls: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $nlsQuery = nlsQuery_example; # String | The natural-language query to embed and search.
my $filterParams = filterParams_example; # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations".
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
my $page = 3.4; # Float | Which page of meeting hits to return.
my $perPage = 3.4; # Float | Number of meeting hits per page.
my $k = 3.4; # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side.
my $useTerritory = true; # Boolean | When true, scope the search to the authenticated user's territory channels.

eval {
    my $result = $api_instance->searchNls(nlsQuery => $nlsQuery, filterParams => $filterParams, dateRange => $dateRange, page => $page, perPage => $perPage, k => $k, useTerritory => $useTerritory);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchNls: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
nlsQuery = nlsQuery_example # String | The natural-language query to embed and search. (default to null)
filterParams = filterParams_example # String | Base64 encoded object containing filter parameters.
The original object may have keys "states", "counties",
"cities", "channel_types", and "organizations". (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
page = 3.4 # Float | Which page of meeting hits to return. (optional) (default to null)
perPage = 3.4 # Float | Number of meeting hits per page. (optional) (default to null)
k = 3.4 # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating. Capped
server-side. (optional) (default to null)
useTerritory = true # Boolean | When true, scope the search to the authenticated user's territory channels. (optional) (default to null)

try:
    api_response = api_instance.search_nls(nlsQuery, filterParams, dateRange=dateRange, page=page, perPage=perPage, k=k, useTerritory=useTerritory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchNls: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let nlsQuery = nlsQuery_example; // String
    let filterParams = filterParams_example; // String
    let dateRange = ; // array[Float]
    let page = 3.4; // Float
    let perPage = 3.4; // Float
    let k = 3.4; // Float
    let useTerritory = true; // Boolean

    let mut context = DefaultApi::Context::default();
    let result = client.searchNls(nlsQuery, filterParams, dateRange, page, perPage, k, useTerritory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
nls-query*
String
The natural-language query to embed and search.
Required
filter-params*
String
Base64 encoded object containing filter parameters. The original object may have keys "states", "counties", "cities", "channel_types", and "organizations".
Required
date-range
array[Float] (float)
An array of 2 integers indicating the start and end time of the search. The integers should correspond to milliseconds since January 1st 1970.
page
Float (float)
Which page of meeting hits to return.
per-page
Float (float)
Number of meeting hits per page.
k
Float (float)
Number of nearest-neighbor transcript hits to retrieve from Elasticsearch before grouping by meeting and paginating. Capped server-side.
use-territory
Boolean
When true, scope the search to the authenticated user's territory channels.

Responses

searchNlsByCampaignId


/search/campaigns/{campaign_id}/nls

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/campaigns/{campaign_id}/nls?date-range=&page=3.4&per-page=3.4&k=3.4"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float campaignId = 3.4; // Float | 
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Float page = 3.4; // Float | Which page of meeting hits to return.
        Float perPage = 3.4; // Float | Number of meeting hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.

        try {
            SearchResult result = apiInstance.searchNlsByCampaignId(campaignId, dateRange, page, perPage, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchNlsByCampaignId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float campaignId = new Float(); // Float | 
final array[Float] dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
final Float page = new Float(); // Float | Which page of meeting hits to return.
final Float perPage = new Float(); // Float | Number of meeting hits per page.
final Float k = new Float(); // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.

try {
    final result = await api_instance.searchNlsByCampaignId(campaignId, dateRange, page, perPage, k);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchNlsByCampaignId: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float campaignId = 3.4; // Float | 
        array[Float] dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
        Float page = 3.4; // Float | Which page of meeting hits to return.
        Float perPage = 3.4; // Float | Number of meeting hits per page.
        Float k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.

        try {
            SearchResult result = apiInstance.searchNlsByCampaignId(campaignId, dateRange, page, perPage, k);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchNlsByCampaignId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *campaignId = 3.4; //  (default to null)
array[Float] *dateRange = ; // An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
Float *page = 3.4; // Which page of meeting hits to return. (optional) (default to null)
Float *perPage = 3.4; // Number of meeting hits per page. (optional) (default to null)
Float *k = 3.4; // Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side. (optional) (default to null)

[apiInstance searchNlsByCampaignIdWith:campaignId
    dateRange:dateRange
    page:page
    perPage:perPage
    k:k
              completionHandler: ^(SearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var campaignId = 3.4; // {Float} 
var opts = {
  'dateRange': , // {array[Float]} An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
  'page': 3.4, // {Float} Which page of meeting hits to return.
  'perPage': 3.4, // {Float} Number of meeting hits per page.
  'k': 3.4 // {Float} Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchNlsByCampaignId(campaignId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchNlsByCampaignIdExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var campaignId = 3.4;  // Float |  (default to null)
            var dateRange = new array[Float](); // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional)  (default to null)
            var page = 3.4;  // Float | Which page of meeting hits to return. (optional)  (default to null)
            var perPage = 3.4;  // Float | Number of meeting hits per page. (optional)  (default to null)
            var k = 3.4;  // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side. (optional)  (default to null)

            try {
                SearchResult result = apiInstance.searchNlsByCampaignId(campaignId, dateRange, page, perPage, k);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchNlsByCampaignId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$campaignId = 3.4; // Float | 
$dateRange = ; // array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
$page = 3.4; // Float | Which page of meeting hits to return.
$perPage = 3.4; // Float | Number of meeting hits per page.
$k = 3.4; // Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.

try {
    $result = $api_instance->searchNlsByCampaignId($campaignId, $dateRange, $page, $perPage, $k);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchNlsByCampaignId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $campaignId = 3.4; # Float | 
my $dateRange = []; # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970.
my $page = 3.4; # Float | Which page of meeting hits to return.
my $perPage = 3.4; # Float | Number of meeting hits per page.
my $k = 3.4; # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side.

eval {
    my $result = $api_instance->searchNlsByCampaignId(campaignId => $campaignId, dateRange => $dateRange, page => $page, perPage => $perPage, k => $k);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchNlsByCampaignId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
campaignId = 3.4 # Float |  (default to null)
dateRange =  # array[Float] | An array of 2 integers indicating the start and end time of
the search. The integers should correspond to milliseconds
since January 1st 1970. (optional) (default to null)
page = 3.4 # Float | Which page of meeting hits to return. (optional) (default to null)
perPage = 3.4 # Float | Number of meeting hits per page. (optional) (default to null)
k = 3.4 # Float | Number of nearest-neighbor transcript hits to retrieve from
Elasticsearch before grouping by meeting and paginating.
Capped server-side. (optional) (default to null)

try:
    api_response = api_instance.search_nls_by_campaign_id(campaignId, dateRange=dateRange, page=page, perPage=perPage, k=k)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchNlsByCampaignId: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let campaignId = 3.4; // Float
    let dateRange = ; // array[Float]
    let page = 3.4; // Float
    let perPage = 3.4; // Float
    let k = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.searchNlsByCampaignId(campaignId, dateRange, page, perPage, k, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
campaign_id*
Float (float)
Required
Query parameters
Name Description
date-range
array[Float] (float)
An array of 2 integers indicating the start and end time of the search. The integers should correspond to milliseconds since January 1st 1970.
page
Float (float)
Which page of meeting hits to return.
per-page
Float (float)
Number of meeting hits per page.
k
Float (float)
Number of nearest-neighbor transcript hits to retrieve from Elasticsearch before grouping by meeting and paginating. Capped server-side.

Responses

searchOpportunities

Get opportunities that the user has access to based on search criteria.


/search/opportunities

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/opportunities?anchor_terms=&count=3.4&cities=&counties=&states=&industry=&organizations=&order=order_example&terms="

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        array[String] anchorTerms = ; // array[String] | List of terms that must exist in title or description. One of these terms must be present.
        Float count = 3.4; // Float | Integer specifying the size of how many results to return at once. Defaults to 25.
        array[Float] cities = ; // array[Float] | List of city id's that the search must filter on.
        array[Float] counties = ; // array[Float] | List of county id's that the search must filter on.
        array[Float] states = ; // array[Float] | List of state id's that the search must filter on.
        array[Float] industry = ; // array[Float] | List of industry id's that the search must filter on.
        array[Float] organizations = ; // array[Float] | List of organization id's that the search must filter on.
        String order = order_example; // String | String specifying the type of sort. Defaults to "desc".
        array[String] terms = ; // array[String] | List of terms that should exist in title or description. One of these terms must be present.

        try {
            SearchOpportunities_200_response result = apiInstance.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchOpportunities");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[String] anchorTerms = new array[String](); // array[String] | List of terms that must exist in title or description. One of these terms must be present.
final Float count = new Float(); // Float | Integer specifying the size of how many results to return at once. Defaults to 25.
final array[Float] cities = new array[Float](); // array[Float] | List of city id's that the search must filter on.
final array[Float] counties = new array[Float](); // array[Float] | List of county id's that the search must filter on.
final array[Float] states = new array[Float](); // array[Float] | List of state id's that the search must filter on.
final array[Float] industry = new array[Float](); // array[Float] | List of industry id's that the search must filter on.
final array[Float] organizations = new array[Float](); // array[Float] | List of organization id's that the search must filter on.
final String order = new String(); // String | String specifying the type of sort. Defaults to "desc".
final array[String] terms = new array[String](); // array[String] | List of terms that should exist in title or description. One of these terms must be present.

try {
    final result = await api_instance.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchOpportunities: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[String] anchorTerms = ; // array[String] | List of terms that must exist in title or description. One of these terms must be present.
        Float count = 3.4; // Float | Integer specifying the size of how many results to return at once. Defaults to 25.
        array[Float] cities = ; // array[Float] | List of city id's that the search must filter on.
        array[Float] counties = ; // array[Float] | List of county id's that the search must filter on.
        array[Float] states = ; // array[Float] | List of state id's that the search must filter on.
        array[Float] industry = ; // array[Float] | List of industry id's that the search must filter on.
        array[Float] organizations = ; // array[Float] | List of organization id's that the search must filter on.
        String order = order_example; // String | String specifying the type of sort. Defaults to "desc".
        array[String] terms = ; // array[String] | List of terms that should exist in title or description. One of these terms must be present.

        try {
            SearchOpportunities_200_response result = apiInstance.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchOpportunities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
array[String] *anchorTerms = ; // List of terms that must exist in title or description. One of these terms must be present. (default to null)
Float *count = 3.4; // Integer specifying the size of how many results to return at once. Defaults to 25. (default to null)
array[Float] *cities = ; // List of city id's that the search must filter on. (default to null)
array[Float] *counties = ; // List of county id's that the search must filter on. (default to null)
array[Float] *states = ; // List of state id's that the search must filter on. (default to null)
array[Float] *industry = ; // List of industry id's that the search must filter on. (default to null)
array[Float] *organizations = ; // List of organization id's that the search must filter on. (default to null)
String *order = order_example; // String specifying the type of sort. Defaults to "desc". (default to null)
array[String] *terms = ; // List of terms that should exist in title or description. One of these terms must be present. (default to null)

[apiInstance searchOpportunitiesWith:anchorTerms
    count:count
    cities:cities
    counties:counties
    states:states
    industry:industry
    organizations:organizations
    order:order
    terms:terms
              completionHandler: ^(SearchOpportunities_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var anchorTerms = ; // {array[String]} List of terms that must exist in title or description. One of these terms must be present.
var count = 3.4; // {Float} Integer specifying the size of how many results to return at once. Defaults to 25.
var cities = ; // {array[Float]} List of city id's that the search must filter on.
var counties = ; // {array[Float]} List of county id's that the search must filter on.
var states = ; // {array[Float]} List of state id's that the search must filter on.
var industry = ; // {array[Float]} List of industry id's that the search must filter on.
var organizations = ; // {array[Float]} List of organization id's that the search must filter on.
var order = order_example; // {String} String specifying the type of sort. Defaults to "desc".
var terms = ; // {array[String]} List of terms that should exist in title or description. One of these terms must be present.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchOpportunitiesExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var anchorTerms = new array[String](); // array[String] | List of terms that must exist in title or description. One of these terms must be present. (default to null)
            var count = 3.4;  // Float | Integer specifying the size of how many results to return at once. Defaults to 25. (default to null)
            var cities = new array[Float](); // array[Float] | List of city id's that the search must filter on. (default to null)
            var counties = new array[Float](); // array[Float] | List of county id's that the search must filter on. (default to null)
            var states = new array[Float](); // array[Float] | List of state id's that the search must filter on. (default to null)
            var industry = new array[Float](); // array[Float] | List of industry id's that the search must filter on. (default to null)
            var organizations = new array[Float](); // array[Float] | List of organization id's that the search must filter on. (default to null)
            var order = order_example;  // String | String specifying the type of sort. Defaults to "desc". (default to null)
            var terms = new array[String](); // array[String] | List of terms that should exist in title or description. One of these terms must be present. (default to null)

            try {
                SearchOpportunities_200_response result = apiInstance.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchOpportunities: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$anchorTerms = ; // array[String] | List of terms that must exist in title or description. One of these terms must be present.
$count = 3.4; // Float | Integer specifying the size of how many results to return at once. Defaults to 25.
$cities = ; // array[Float] | List of city id's that the search must filter on.
$counties = ; // array[Float] | List of county id's that the search must filter on.
$states = ; // array[Float] | List of state id's that the search must filter on.
$industry = ; // array[Float] | List of industry id's that the search must filter on.
$organizations = ; // array[Float] | List of organization id's that the search must filter on.
$order = order_example; // String | String specifying the type of sort. Defaults to "desc".
$terms = ; // array[String] | List of terms that should exist in title or description. One of these terms must be present.

try {
    $result = $api_instance->searchOpportunities($anchorTerms, $count, $cities, $counties, $states, $industry, $organizations, $order, $terms);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchOpportunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $anchorTerms = []; # array[String] | List of terms that must exist in title or description. One of these terms must be present.
my $count = 3.4; # Float | Integer specifying the size of how many results to return at once. Defaults to 25.
my $cities = []; # array[Float] | List of city id's that the search must filter on.
my $counties = []; # array[Float] | List of county id's that the search must filter on.
my $states = []; # array[Float] | List of state id's that the search must filter on.
my $industry = []; # array[Float] | List of industry id's that the search must filter on.
my $organizations = []; # array[Float] | List of organization id's that the search must filter on.
my $order = order_example; # String | String specifying the type of sort. Defaults to "desc".
my $terms = []; # array[String] | List of terms that should exist in title or description. One of these terms must be present.

eval {
    my $result = $api_instance->searchOpportunities(anchorTerms => $anchorTerms, count => $count, cities => $cities, counties => $counties, states => $states, industry => $industry, organizations => $organizations, order => $order, terms => $terms);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchOpportunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
anchorTerms =  # array[String] | List of terms that must exist in title or description. One of these terms must be present. (default to null)
count = 3.4 # Float | Integer specifying the size of how many results to return at once. Defaults to 25. (default to null)
cities =  # array[Float] | List of city id's that the search must filter on. (default to null)
counties =  # array[Float] | List of county id's that the search must filter on. (default to null)
states =  # array[Float] | List of state id's that the search must filter on. (default to null)
industry =  # array[Float] | List of industry id's that the search must filter on. (default to null)
organizations =  # array[Float] | List of organization id's that the search must filter on. (default to null)
order = order_example # String | String specifying the type of sort. Defaults to "desc". (default to null)
terms =  # array[String] | List of terms that should exist in title or description. One of these terms must be present. (default to null)

try:
    api_response = api_instance.search_opportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchOpportunities: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let anchorTerms = ; // array[String]
    let count = 3.4; // Float
    let cities = ; // array[Float]
    let counties = ; // array[Float]
    let states = ; // array[Float]
    let industry = ; // array[Float]
    let organizations = ; // array[Float]
    let order = order_example; // String
    let terms = ; // array[String]

    let mut context = DefaultApi::Context::default();
    let result = client.searchOpportunities(anchorTerms, count, cities, counties, states, industry, organizations, order, terms, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
anchor_terms*
array[String]
List of terms that must exist in title or description. One of these terms must be present.
Required
count*
Float (float)
Integer specifying the size of how many results to return at once. Defaults to 25.
Required
cities*
array[Float] (float)
List of city id's that the search must filter on.
Required
counties*
array[Float] (float)
List of county id's that the search must filter on.
Required
states*
array[Float] (float)
List of state id's that the search must filter on.
Required
industry*
array[Float] (float)
List of industry id's that the search must filter on.
Required
organizations*
array[Float] (float)
List of organization id's that the search must filter on.
Required
order*
String
String specifying the type of sort. Defaults to "desc".
Required
terms*
array[String]
List of terms that should exist in title or description. One of these terms must be present.
Required

Responses

searchPromotionMeeting


/search/promotion/{meeting_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/promotion/{meeting_id}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | 

        try {
            'String' result = apiInstance.searchPromotionMeeting(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchPromotionMeeting");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Float meetingId = new Float(); // Float | 

try {
    final result = await api_instance.searchPromotionMeeting(meetingId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchPromotionMeeting: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Float meetingId = 3.4; // Float | 

        try {
            'String' result = apiInstance.searchPromotionMeeting(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchPromotionMeeting");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Float *meetingId = 3.4; //  (default to null)

[apiInstance searchPromotionMeetingWith:meetingId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var meetingId = 3.4; // {Float} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchPromotionMeeting(meetingId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchPromotionMeetingExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var meetingId = 3.4;  // Float |  (default to null)

            try {
                'String' result = apiInstance.searchPromotionMeeting(meetingId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchPromotionMeeting: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$meetingId = 3.4; // Float | 

try {
    $result = $api_instance->searchPromotionMeeting($meetingId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchPromotionMeeting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $meetingId = 3.4; # Float | 

eval {
    my $result = $api_instance->searchPromotionMeeting(meetingId => $meetingId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchPromotionMeeting: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
meetingId = 3.4 # Float |  (default to null)

try:
    api_response = api_instance.search_promotion_meeting(meetingId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchPromotionMeeting: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let meetingId = 3.4; // Float

    let mut context = DefaultApi::Context::default();
    let result = client.searchPromotionMeeting(meetingId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
meeting_id*
Float (float)
Required

Responses

searchUsageStats

Per-user usage stats for the caller's user organization: signal delivery/open/click counts, meeting/document detail views, searches performed, and campaign subscriptions.


/search/usage-stats

Usage and SDK Samples

curl -X GET \
-H "x-api-key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://dataapi.cloverleaf.ai/search/usage-stats?start_date=2013-10-20&end_date=2013-10-20"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        date startDate = 2013-10-20; // date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
        date endDate = 2013-10-20; // date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

        try {
            array[UsageStatsUserMetrics] result = apiInstance.searchUsageStats(startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchUsageStats");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final date startDate = new date(); // date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
final date endDate = new date(); // date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

try {
    final result = await api_instance.searchUsageStats(startDate, endDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsageStats: $e\n');
}


import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        date startDate = 2013-10-20; // date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
        date endDate = 2013-10-20; // date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

        try {
            array[UsageStatsUserMetrics] result = apiInstance.searchUsageStats(startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchUsageStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
date *startDate = 2013-10-20; // Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day). (default to null)
date *endDate = 2013-10-20; // Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date. (default to null)

[apiInstance searchUsageStatsWith:startDate
    endDate:endDate
              completionHandler: ^(array[UsageStatsUserMetrics] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CloverleafSearchApi = require('cloverleaf_search_api');
var defaultClient = CloverleafSearchApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token";

// Create an instance of the API class
var api = new CloverleafSearchApi.DefaultApi()
var startDate = 2013-10-20; // {date} Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
var endDate = 2013-10-20; // {date} Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUsageStats(startDate, endDate, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUsageStatsExample
    {
        public void main()
        {
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var startDate = 2013-10-20;  // date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day). (default to null)
            var endDate = 2013-10-20;  // date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date. (default to null)

            try {
                array[UsageStatsUserMetrics] result = apiInstance.searchUsageStats(startDate, endDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.searchUsageStats: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$startDate = 2013-10-20; // date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
$endDate = 2013-10-20; // date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

try {
    $result = $api_instance->searchUsageStats($startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchUsageStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::OPenAPIClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $startDate = 2013-10-20; # date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
my $endDate = 2013-10-20; # date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date.

eval {
    my $result = $api_instance->searchUsageStats(startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchUsageStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
openapi_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
startDate = 2013-10-20 # date | Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day). (default to null)
endDate = 2013-10-20 # date | Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day).
Must be on or after start_date. (default to null)

try:
    api_response = api_instance.search_usage_stats(startDate, endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchUsageStats: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let startDate = 2013-10-20; // date
    let endDate = 2013-10-20; // date

    let mut context = DefaultApi::Context::default();
    let result = client.searchUsageStats(startDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
start_date*
date (date)
Inclusive start of the reporting window (YYYY-MM-DD, UTC calendar day).
Required
end_date*
date (date)
Inclusive end of the reporting window (YYYY-MM-DD, UTC calendar day). Must be on or after start_date.
Required

Responses