ContentAnalysisApi

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

Method	HTTP request	Description
contentAnalysisIdList	POST /v3/content_analysis/id_list
contentAnalysisAvailableFilters	GET /v3/content_analysis/available_filters
locations	GET /v3/content_analysis/locations
languages	GET /v3/content_analysis/languages
contentAnalysisCategories	GET /v3/content_analysis/categories
searchLive	POST /v3/content_analysis/search/live
contentAnalysisSummaryLive	POST /v3/content_analysis/summary/live
sentimentAnalysisLive	POST /v3/content_analysis/sentiment_analysis/live
ratingDistributionLive	POST /v3/content_analysis/rating_distribution/live
phraseTrendsLive	POST /v3/content_analysis/phrase_trends/live
categoryTrendsLive	POST /v3/content_analysis/category_trends/live

contentAnalysisIdList

ContentAnalysisIdListResponseInfo contentAnalysisIdList()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_id_list_request_infoimportList[Optional[ContentAnalysisIdListRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.content_analysis_id_list([ContentAnalysisIdListRequestInfo(
limit=10,
include_metadata=True,
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisIdListRequestInfo]]&gt;**](List[Optional[ContentAnalysisIdListRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisIdListResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

contentAnalysisAvailableFilters

ContentAnalysisAvailableFiltersResponseInfo contentAnalysisAvailableFilters()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfrompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.content_analysis_available_filters()
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

 This endpoint does not need any parameter.

Return type

ContentAnalysisAvailableFiltersResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

locations

ContentAnalysisLocationsResponseInfo locations()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfrompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.locations()
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

 This endpoint does not need any parameter.

Return type

ContentAnalysisLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

languages

ContentAnalysisLanguagesResponseInfo languages()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfrompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.languages()
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

 This endpoint does not need any parameter.

Return type

ContentAnalysisLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

contentAnalysisCategories

ContentAnalysisCategoriesResponseInfo contentAnalysisCategories()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfrompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.content_analysis_categories()
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

 This endpoint does not need any parameter.

Return type

ContentAnalysisCategoriesResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

searchLive

ContentAnalysisSearchLiveResponseInfo searchLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_search_live_request_infoimportList[Optional[ContentAnalysisSearchLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.search_live([ContentAnalysisSearchLiveRequestInfo(
keyword_fields={
},
keyword="logitech",
page_type=[
"ecommerce",
"news",
"blogs",
"message-boards",
"organization",
],
search_mode="as_is",
filters=[
"main_domain",
"=",
"reviewfinder.ca",
],
order_by=[
"content_info.sentiment_connotations.anger,desc",
],
limit=10,
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisSearchLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisSearchLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisSearchLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

contentAnalysisSummaryLive

ContentAnalysisSummaryLiveResponseInfo contentAnalysisSummaryLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_summary_live_request_infoimportList[Optional[ContentAnalysisSummaryLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.content_analysis_summary_live([ContentAnalysisSummaryLiveRequestInfo(
keyword="logitech",
page_type=[
"ecommerce",
"news",
"blogs",
"message-boards",
"organization",
],
internal_list_limit=8,
positive_connotation_threshold=0.5,
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisSummaryLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisSummaryLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

sentimentAnalysisLive

ContentAnalysisSentimentAnalysisLiveResponseInfo sentimentAnalysisLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_sentiment_analysis_live_request_infoimportList[Optional[ContentAnalysisSentimentAnalysisLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.sentiment_analysis_live([ContentAnalysisSentimentAnalysisLiveRequestInfo(
keyword="logitech",
internal_list_limit=1,
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisSentimentAnalysisLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisSentimentAnalysisLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisSentimentAnalysisLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

ratingDistributionLive

ContentAnalysisRatingDistributionLiveResponseInfo ratingDistributionLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_rating_distribution_live_request_infoimportList[Optional[ContentAnalysisRatingDistributionLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.rating_distribution_live([ContentAnalysisRatingDistributionLiveRequestInfo(
keyword="logitech",
search_mode="as_is",
internal_list_limit=10,
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisRatingDistributionLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisRatingDistributionLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisRatingDistributionLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

phraseTrendsLive

ContentAnalysisPhraseTrendsLiveResponseInfo phraseTrendsLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_phrase_trends_live_request_infoimportList[Optional[ContentAnalysisPhraseTrendsLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.phrase_trends_live([ContentAnalysisPhraseTrendsLiveRequestInfo(
keyword="logitech",
search_mode="as_is",
date_group="month",
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisPhraseTrendsLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisPhraseTrendsLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisPhraseTrendsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

categoryTrendsLive

ContentAnalysisCategoryTrendsLiveResponseInfo categoryTrendsLive()

Example

fromdataforseo_clientimportconfigurationasdfs_config, api_clientasdfs_api_providerfromdataforseo_client.api.content_analysis_apiimportContentAnalysisApifromdataforseo_client.restimportApiExceptionfromdataforseo_client.models.list_optional_content_analysis_category_trends_live_request_infoimportList[Optional[ContentAnalysisCategoryTrendsLiveRequestInfo]]
frompprintimportpprinttry:
# Configure HTTP basic authorization: basicAuthconfiguration=dfs_config.Configuration(username='USERNAME',password='PASSWORD')
withdfs_api_provider.ApiClient(configuration) asapi_client:
# Create an instance of the API classcontent_analysis_api=ContentAnalysisApi(api_client)
response=content_analysis_api.category_trends_live([ContentAnalysisCategoryTrendsLiveRequestInfo(
category_code=10994,
search_mode="as_is",
date_group="month",
)]
)
exceptApiExceptionase:
print("Exception: %s\n"%e)

Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List&lt;List[Optional[ContentAnalysisCategoryTrendsLiveRequestInfo]]&gt;**](List[Optional[ContentAnalysisCategoryTrendsLiveRequestInfo]].md)| | [optional] |

Return type

ContentAnalysisCategoryTrendsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

Uh oh!

FilesExpand file tree

content_analysis_api.md

Latest commit

History

content_analysis_api.md

File metadata and controls

ContentAnalysisApi

contentAnalysisIdList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contentAnalysisAvailableFilters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

locations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

languages

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contentAnalysisCategories

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

searchLive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contentAnalysisSummaryLive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

sentimentAnalysisLive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ratingDistributionLive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

phraseTrendsLive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

categoryTrendsLive

Example