unifapi.GeoApi

All URIs are relative to https://api.unifapi.com

Method	HTTP request	Description
geo_keywords_search_volume_post	POST /geo/keywords/search-volume	Get AI search volume for keywords
geo_mentions_aggregated_metrics_post	POST /geo/mentions/aggregated-metrics	Aggregate LLM mention metrics by dimension
geo_mentions_cross_aggregated_metrics_post	POST /geo/mentions/cross-aggregated-metrics	Compare LLM mentions across labeled groups
geo_mentions_search_post	POST /geo/mentions/search	Search LLM mentions of a domain or keyword
geo_mentions_top_domains_post	POST /geo/mentions/top-domains	List domains most cited in LLM answers
geo_mentions_top_pages_post	POST /geo/mentions/top-pages	List pages most cited in LLM answers
geo_serp_post	POST /geo/serp	Search AI Mode generative results

geo_keywords_search_volume_post

GeoKeywordsSearchVolumePost200Response geo_keywords_search_volume_post(geo_keyword_search_volume_request=geo_keyword_search_volume_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_keyword_search_volume_request import GeoKeywordSearchVolumeRequest
from unifapi.models.geo_keywords_search_volume_post200_response import GeoKeywordsSearchVolumePost200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_keyword_search_volume_request = unifapi.GeoKeywordSearchVolumeRequest() # GeoKeywordSearchVolumeRequest |  (optional)

    try:
        # Get AI search volume for keywords
        api_response = api_instance.geo_keywords_search_volume_post(geo_keyword_search_volume_request=geo_keyword_search_volume_request)
        print("The response of GeoApi->geo_keywords_search_volume_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_keywords_search_volume_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_keyword_search_volume_request	GeoKeywordSearchVolumeRequest		[optional]

Return type

GeoKeywordsSearchVolumePost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_mentions_aggregated_metrics_post

GeoMentionsAggregatedMetricsPost200Response geo_mentions_aggregated_metrics_post(geo_mentions_aggregated_metrics_request=geo_mentions_aggregated_metrics_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_mentions_aggregated_metrics_post200_response import GeoMentionsAggregatedMetricsPost200Response
from unifapi.models.geo_mentions_aggregated_metrics_request import GeoMentionsAggregatedMetricsRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_mentions_aggregated_metrics_request = unifapi.GeoMentionsAggregatedMetricsRequest() # GeoMentionsAggregatedMetricsRequest |  (optional)

    try:
        # Aggregate LLM mention metrics by dimension
        api_response = api_instance.geo_mentions_aggregated_metrics_post(geo_mentions_aggregated_metrics_request=geo_mentions_aggregated_metrics_request)
        print("The response of GeoApi->geo_mentions_aggregated_metrics_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_mentions_aggregated_metrics_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_mentions_aggregated_metrics_request	GeoMentionsAggregatedMetricsRequest		[optional]

Return type

GeoMentionsAggregatedMetricsPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_mentions_cross_aggregated_metrics_post

GeoMentionsCrossAggregatedMetricsPost200Response geo_mentions_cross_aggregated_metrics_post(geo_mentions_cross_aggregated_metrics_request=geo_mentions_cross_aggregated_metrics_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_mentions_cross_aggregated_metrics_post200_response import GeoMentionsCrossAggregatedMetricsPost200Response
from unifapi.models.geo_mentions_cross_aggregated_metrics_request import GeoMentionsCrossAggregatedMetricsRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_mentions_cross_aggregated_metrics_request = unifapi.GeoMentionsCrossAggregatedMetricsRequest() # GeoMentionsCrossAggregatedMetricsRequest |  (optional)

    try:
        # Compare LLM mentions across labeled groups
        api_response = api_instance.geo_mentions_cross_aggregated_metrics_post(geo_mentions_cross_aggregated_metrics_request=geo_mentions_cross_aggregated_metrics_request)
        print("The response of GeoApi->geo_mentions_cross_aggregated_metrics_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_mentions_cross_aggregated_metrics_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_mentions_cross_aggregated_metrics_request	GeoMentionsCrossAggregatedMetricsRequest		[optional]

Return type

GeoMentionsCrossAggregatedMetricsPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_mentions_search_post

GeoMentionsSearchPost200Response geo_mentions_search_post(geo_mentions_search_request=geo_mentions_search_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_mentions_search_post200_response import GeoMentionsSearchPost200Response
from unifapi.models.geo_mentions_search_request import GeoMentionsSearchRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_mentions_search_request = unifapi.GeoMentionsSearchRequest() # GeoMentionsSearchRequest |  (optional)

    try:
        # Search LLM mentions of a domain or keyword
        api_response = api_instance.geo_mentions_search_post(geo_mentions_search_request=geo_mentions_search_request)
        print("The response of GeoApi->geo_mentions_search_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_mentions_search_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_mentions_search_request	GeoMentionsSearchRequest		[optional]

Return type

GeoMentionsSearchPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_mentions_top_domains_post

GeoMentionsTopDomainsPost200Response geo_mentions_top_domains_post(geo_mentions_top_domains_request=geo_mentions_top_domains_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_mentions_top_domains_post200_response import GeoMentionsTopDomainsPost200Response
from unifapi.models.geo_mentions_top_domains_request import GeoMentionsTopDomainsRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_mentions_top_domains_request = unifapi.GeoMentionsTopDomainsRequest() # GeoMentionsTopDomainsRequest |  (optional)

    try:
        # List domains most cited in LLM answers
        api_response = api_instance.geo_mentions_top_domains_post(geo_mentions_top_domains_request=geo_mentions_top_domains_request)
        print("The response of GeoApi->geo_mentions_top_domains_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_mentions_top_domains_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_mentions_top_domains_request	GeoMentionsTopDomainsRequest		[optional]

Return type

GeoMentionsTopDomainsPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_mentions_top_pages_post

GeoMentionsTopPagesPost200Response geo_mentions_top_pages_post(geo_mentions_top_pages_request=geo_mentions_top_pages_request)

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

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_mentions_top_pages_post200_response import GeoMentionsTopPagesPost200Response
from unifapi.models.geo_mentions_top_pages_request import GeoMentionsTopPagesRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_mentions_top_pages_request = unifapi.GeoMentionsTopPagesRequest() # GeoMentionsTopPagesRequest |  (optional)

    try:
        # List pages most cited in LLM answers
        api_response = api_instance.geo_mentions_top_pages_post(geo_mentions_top_pages_request=geo_mentions_top_pages_request)
        print("The response of GeoApi->geo_mentions_top_pages_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_mentions_top_pages_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_mentions_top_pages_request	GeoMentionsTopPagesRequest		[optional]

Return type

GeoMentionsTopPagesPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

geo_serp_post

GeoSerpPost200Response geo_serp_post(geo_serp_request=geo_serp_request)

Search AI Mode generative results

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

Example

Bearer Authentication (bearerAuth):

import unifapi
from unifapi.models.geo_serp_post200_response import GeoSerpPost200Response
from unifapi.models.geo_serp_request import GeoSerpRequest
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.GeoApi(api_client)
    geo_serp_request = unifapi.GeoSerpRequest() # GeoSerpRequest |  (optional)

    try:
        # Search AI Mode generative results
        api_response = api_instance.geo_serp_post(geo_serp_request=geo_serp_request)
        print("The response of GeoApi->geo_serp_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeoApi->geo_serp_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
geo_serp_request	GeoSerpRequest		[optional]

Return type

GeoSerpPost200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Validation or invalid-id error	-
401	Missing, invalid, disabled, revoked, or expired UnifAPI API key	-
402	Insufficient workspace credits	-
404	Resource not found	-
429	Rate limited	-
500	Internal error	-
502	Source error	-
503	Source unavailable	-

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

FilesExpand file tree

GeoApi.md

Latest commit

History

GeoApi.md

File metadata and controls

unifapi.GeoApi

geo_keywords_search_volume_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_mentions_aggregated_metrics_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_mentions_cross_aggregated_metrics_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_mentions_search_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_mentions_top_domains_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_mentions_top_pages_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

geo_serp_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details