DataForSEO: Content Analysis Summary Live

This endpoint will provide you with an overview of citation data available for the target keyword.

Tool ID: dataforseo_content_analysis_summary_live

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_content_analysis_summary_live',
  {
    "keyword": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_content_analysis_summary_live --input '{
  "keyword": "software companies hiring engineers"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}

Use deepline describe dataforseo_content_analysis_summary_live --json for the latest machine-readable contract.

Input reference

This endpoint will provide you with an overview of citation data available for the target keyword.

Name	Type	Required	Default	Details
`payload.keyword`	`string`	Yes	—	target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format. Note : to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes. example: “keyword”: ""tesla palo alto"" learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
`payload.keyword_fields`	`object`	No	—	target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain. fields you can specify: title , main_title , previous_title , snippet you can indicate several fields. Note : to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes. example: “keyword_fields”: { “snippet”: ""logitech mouse"", “main_title”: “sale” }
`payload.page_type`	`array`	No	—	target page types optional field use this parameter to filter the dataset by page types possible values: “ecommerce” , “news” , “blogs” , “message-boards” , “organization”
`payload.internal_list_limit`	`integer`	No	—	maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum value: 20
`payload.positive_connotation_threshold`	`number`	No	—	positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value possible values: from 0 to 1 default value: 0.4
`payload.sentiments_connotation_threshold`	`number`	No	—	sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value possible values: from 0 to 1 default value: 0.4
`payload.initial_dataset_filters`	`array`	No	—	initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator and , or between the conditions the following operators are supported: regex , not_regex , < , <= , > , >= , = , <> , in , not_in , like , not_like , has , has_not you can use the % operator with like and not_like to match any string of zero or more characters example: [“domain”,”<>”, See the live schema for the complete constraint.
`payload.rank_scale`	`string`	No	—	defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article
`payload.tag`	`string`	No	—	user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Output reference

Top-level response envelope for dataforseo_content_analysis_summary_live.

Name	Type	Required	Default	Details
`result.version`	`string`	Yes	—	the current version of the API
`result.status_code`	`integer`	Yes	—	general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
`result.status_message`	`string`	Yes	—	general informational message you can find the full list of general informational messages here
`result.time`	`string`	Yes	—	execution time, seconds
`result.tasks_count`	`integer`	Yes	—	the number of tasks in the tasks array
`result.tasks_error`	`integer`	Yes	—	the number of tasks in the tasks array returned with an error
`result.tasks`	`array`	Yes	—	array of tasks

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.01 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation