> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Dataforseo Business Data Business Listings Categories
> Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_business_data_business_listings_categories_aggregation_live:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| --------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.categories` | `array` | No | | business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up to 10 categories |
| `payload.description` | `string` | No | | description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters |
| `payload.title` | `string` | No | | title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters |
| `payload.is_claimed` | `boolean` | No | | indicates whether the business is verified by its owner on Google Maps optional field |
| `payload.location_coordinate` | `string` | No | | GPS coordinates of a location optional field location\_coordinate parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude" : 7 the minimum value for "radius" : 1 the maximum value for "radius" : 100000 example: 53.476225,-2.243572,200 |
| `payload.initial_dataset_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 , like , not\_like , match , not\_match you can use the % operator with like and not\_like to match any string of zero or more characters example: \["rating.value",">",3] you can receive the list of available filters by making a separate request to [https://api.dataforseo.com/v3/business\_data/business\_listings/available\_filters](https://api.dataforseo.com/v3/business_data/business_listings/available_filters) The full list of possible filters is available here. |
| `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 aggregated categories default value: 10 |
| `payload.limit` | `integer` | No | | the maximum number of returned businesses optional field default value: 100 maximum value: 1000 |
| `payload.offset` | `integer` | No | | the maximum number of returned businesses optional field |
| `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 |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters.",
"properties": {
"categories": {
"type": "array",
"description": "business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up to 10 categories",
"items": {}
},
"description": {
"type": "string",
"description": "description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters"
},
"title": {
"type": "string",
"description": "title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters"
},
"is_claimed": {
"type": "boolean",
"description": "indicates whether the business is verified by its owner on Google Maps optional field"
},
"location_coordinate": {
"type": "string",
"description": "GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\" : 7 the minimum value for \"radius\" : 1 the maximum value for \"radius\" : 100000 example: 53.476225,-2.243572,200"
},
"initial_dataset_filters": {
"type": "array",
"description": "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 , like , not_like , match , not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here.",
"items": {}
},
"internal_list_limit": {
"type": "integer",
"description": "maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the aggregated categories default value: 10"
},
"limit": {
"type": "integer",
"description": "the maximum number of returned businesses optional field default value: 100 maximum value: 1000"
},
"offset": {
"type": "integer",
"description": "the maximum number of returned businesses optional field"
},
"tag": {
"type": "string",
"description": "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"
}
},
"additionalProperties": false
}
```
## 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 |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Top-level response envelope for dataforseo_business_data_business_listings_categories_aggregation_live.",
"properties": {
"version": {
"type": "string",
"description": "the current version of the API"
},
"status_code": {
"type": "integer",
"description": "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"
},
"status_message": {
"type": "string",
"description": "general informational message you can find the full list of general informational messages here"
},
"time": {
"type": "string",
"description": "execution time, seconds"
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array"
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error"
},
"tasks": {
"type": "array",
"description": "array of tasks",
"items": {}
}
},
"required": [
"version",
"status_code",
"status_message",
"time",
"tasks_count",
"tasks_error",
"tasks"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute dataforseo_business_data_business_listings_categories_aggregation_live --payload '{}' --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.01` per pricing unit.
* Billing mode: `post_deduct`.