Unifapi\Sdk\GeoApi

All URIs are relative to https://api.unifapi.com, except if the operation defines another base path.

Method	HTTP request	Description
geoKeywordsSearchVolumePost()	POST /geo/keywords/search-volume	Get AI search volume for keywords
geoMentionsAggregatedMetricsPost()	POST /geo/mentions/aggregated-metrics	Aggregate LLM mention metrics by dimension
geoMentionsCrossAggregatedMetricsPost()	POST /geo/mentions/cross-aggregated-metrics	Compare LLM mentions across labeled groups
geoMentionsSearchPost()	POST /geo/mentions/search	Search LLM mentions of a domain or keyword
geoMentionsTopDomainsPost()	POST /geo/mentions/top-domains	List domains most cited in LLM answers
geoMentionsTopPagesPost()	POST /geo/mentions/top-pages	List pages most cited in LLM answers
geoSerpPost()	POST /geo/serp	Search AI Mode generative results

`geoKeywordsSearchVolumePost()`

geoKeywordsSearchVolumePost($geo_keyword_search_volume_request): \Unifapi\\Sdk\Model\GeoKeywordsSearchVolumePost200Response

Get AI search volume for keywords

Look up generative-AI search volume and monthly trend for up to 1000 keywords in a location and language.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_keyword_search_volume_request = new \Unifapi\\Sdk\Model\GeoKeywordSearchVolumeRequest(); // \Unifapi\\Sdk\Model\GeoKeywordSearchVolumeRequest

try {
    $result = $apiInstance->geoKeywordsSearchVolumePost($geo_keyword_search_volume_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoKeywordsSearchVolumePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_keyword_search_volume_request	\Unifapi\Sdk\Model\GeoKeywordSearchVolumeRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoKeywordsSearchVolumePost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoMentionsAggregatedMetricsPost()`

geoMentionsAggregatedMetricsPost($geo_mentions_aggregated_metrics_request): \Unifapi\\Sdk\Model\GeoMentionsAggregatedMetricsPost200Response

Aggregate LLM mention metrics by dimension

Aggregate LLM mentions of a domain or keyword across platform, location, language, source/search-result domains, and brand entities.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_mentions_aggregated_metrics_request = new \Unifapi\\Sdk\Model\GeoMentionsAggregatedMetricsRequest(); // \Unifapi\\Sdk\Model\GeoMentionsAggregatedMetricsRequest

try {
    $result = $apiInstance->geoMentionsAggregatedMetricsPost($geo_mentions_aggregated_metrics_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoMentionsAggregatedMetricsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_mentions_aggregated_metrics_request	\Unifapi\Sdk\Model\GeoMentionsAggregatedMetricsRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoMentionsAggregatedMetricsPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoMentionsCrossAggregatedMetricsPost()`

geoMentionsCrossAggregatedMetricsPost($geo_mentions_cross_aggregated_metrics_request): \Unifapi\\Sdk\Model\GeoMentionsCrossAggregatedMetricsPost200Response

Compare LLM mentions across labeled groups

Aggregate and compare LLM mention metrics across several labeled target groups for side-by-side share-of-voice analysis.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_mentions_cross_aggregated_metrics_request = new \Unifapi\\Sdk\Model\GeoMentionsCrossAggregatedMetricsRequest(); // \Unifapi\\Sdk\Model\GeoMentionsCrossAggregatedMetricsRequest

try {
    $result = $apiInstance->geoMentionsCrossAggregatedMetricsPost($geo_mentions_cross_aggregated_metrics_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoMentionsCrossAggregatedMetricsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_mentions_cross_aggregated_metrics_request	\Unifapi\Sdk\Model\GeoMentionsCrossAggregatedMetricsRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoMentionsCrossAggregatedMetricsPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoMentionsSearchPost()`

geoMentionsSearchPost($geo_mentions_search_request): \Unifapi\\Sdk\Model\GeoMentionsSearchPost200Response

Search LLM mentions of a domain or keyword

Find where a domain or keyword is mentioned across ChatGPT and AI search answers, with the question, answer, cited sources, and AI search volume.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_mentions_search_request = new \Unifapi\\Sdk\Model\GeoMentionsSearchRequest(); // \Unifapi\\Sdk\Model\GeoMentionsSearchRequest

try {
    $result = $apiInstance->geoMentionsSearchPost($geo_mentions_search_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoMentionsSearchPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_mentions_search_request	\Unifapi\Sdk\Model\GeoMentionsSearchRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoMentionsSearchPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoMentionsTopDomainsPost()`

geoMentionsTopDomainsPost($geo_mentions_top_domains_request): \Unifapi\\Sdk\Model\GeoMentionsTopDomainsPost200Response

List domains most cited in LLM answers

Rank the domains most frequently cited as sources in LLM answers for a target domain or keyword, with per-dimension breakdowns.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_mentions_top_domains_request = new \Unifapi\\Sdk\Model\GeoMentionsTopDomainsRequest(); // \Unifapi\\Sdk\Model\GeoMentionsTopDomainsRequest

try {
    $result = $apiInstance->geoMentionsTopDomainsPost($geo_mentions_top_domains_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoMentionsTopDomainsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_mentions_top_domains_request	\Unifapi\Sdk\Model\GeoMentionsTopDomainsRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoMentionsTopDomainsPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoMentionsTopPagesPost()`

geoMentionsTopPagesPost($geo_mentions_top_pages_request): \Unifapi\\Sdk\Model\GeoMentionsTopPagesPost200Response

List pages most cited in LLM answers

Rank the pages most frequently cited as sources in LLM answers for a target domain or keyword, with per-dimension breakdowns.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_mentions_top_pages_request = new \Unifapi\\Sdk\Model\GeoMentionsTopPagesRequest(); // \Unifapi\\Sdk\Model\GeoMentionsTopPagesRequest

try {
    $result = $apiInstance->geoMentionsTopPagesPost($geo_mentions_top_pages_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoMentionsTopPagesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_mentions_top_pages_request	\Unifapi\Sdk\Model\GeoMentionsTopPagesRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoMentionsTopPagesPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`geoSerpPost()`

geoSerpPost($geo_serp_request): \Unifapi\\Sdk\Model\GeoSerpPost200Response

Search AI Mode generative results

Run one live AI Mode search for generative answer evidence, cited sources, and target-domain visibility.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Unifapi\\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Unifapi\\Sdk\Api\GeoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$geo_serp_request = new \Unifapi\\Sdk\Model\GeoSerpRequest(); // \Unifapi\\Sdk\Model\GeoSerpRequest

try {
    $result = $apiInstance->geoSerpPost($geo_serp_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoApi->geoSerpPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
geo_serp_request	\Unifapi\Sdk\Model\GeoSerpRequest		[optional]

Return type

\Unifapi\Sdk\Model\GeoSerpPost200Response

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

GeoApi.md

Latest commit

History

GeoApi.md

File metadata and controls

Unifapi\Sdk\GeoApi

geoKeywordsSearchVolumePost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoMentionsAggregatedMetricsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoMentionsCrossAggregatedMetricsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoMentionsSearchPost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoMentionsTopDomainsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoMentionsTopPagesPost()

Example

Parameters

Return type

Authorization

HTTP request headers

geoSerpPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`geoKeywordsSearchVolumePost()`

`geoMentionsAggregatedMetricsPost()`

`geoMentionsCrossAggregatedMetricsPost()`

`geoMentionsSearchPost()`

`geoMentionsTopDomainsPost()`

`geoMentionsTopPagesPost()`

`geoSerpPost()`