Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_dataforseo_labs_amazon_product_keyword_intersections_live:{"asins":{}}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
payload.asins | object | Yes | asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: “asins”: { “1”: “019005476X”, “2”: “0190074442” } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page | |
payload.location_name | string | No | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United Kingdom | |
payload.location_code | integer | No | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840 | |
payload.language_name | string | No | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English | |
payload.language_code | string | No | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en | |
payload.limit | integer | No | the maximum number of products in the results array optional field default value: 100 ; maximum value: 1000 | |
payload.intersection_mode | string | No | mode for finding asin intersections optional field possible values: union , intersect ; default value: intersect ; learn more about the parameter in this help center guide | |
payload.filters | array | No | array of results filtering parameters optional field 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 , ilike , not_ilike , like , not_like , match , not_match you can use the % operator with like and not_like , as well as ilike and not_ilike to match any string of zero or more characters example: [“avg_position”,”<”, 10] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide | |
payload.order_by | array | No | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [“sum_position,desc”] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [“intersections,desc”,“avg_position,asc”] default rule: [“intersections,desc”] | |
payload.offset | integer | No | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords | |
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 Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute dataforseo_dataforseo_labs_amazon_product_keyword_intersections_live --payload '{
"asins": {}
}' --json
CLI flags
| Flag | Description |
|---|---|
--json | Print machine-readable output. |
--wait | Wait for terminal provider status when supported. |
--debug | Enable wait mode with additional status/log output. |
--wait-timeout SECONDS | Max seconds to wait in wait mode. |
--poll-interval SECONDS | Polling interval in seconds during wait mode. |
--timeout SECONDS | Request timeout in seconds. |
--connect-timeout SECONDS | Connection timeout in seconds. |
Cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.01per pricing unit. - Billing mode:
post_deduct.