> ## 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.
# Enigma Brand Revenue Search: Inputs, Cost & CLI Example
> Sizing a private business or multi-location group by card-spend revenue per location when no public financials exist. Enigma Enigma Brand Revenue Search docs
## 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=enigma_brand_revenue_search:{"name":"{{name}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ---------------- | ----------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.name` | `string` | Yes | | Brand, DBA, or business name to resolve to operating locations. |
| `payload.state` | `string` | No | | Optional two-letter US state code. Applied by Deepline as a post-response filter on the resolved location address, because Enigma matches brand names nationwide. |
| `payload.period` | `"1m" \| "3m" \| "12m"` | No | `"12m"` | Reporting window for the returned quantities. |
### Allowed values
| Field | Allowed values |
| ---------------- | ----------------- |
| `payload.period` | `1m`, `3m`, `12m` |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Resolves a brand or business name to its operating locations and returns 12-month projected card revenue, average ticket, transaction count, and year-over-year growth per location. Enigma matches brand names nationwide, so callers filtering to a single operator must gate results on the returned address state. The `state` property in this schema is applied by the Deepline runtime as a post-response filter, not as an upstream search constraint: Enigma's `searchInput.address` behaves as a match hint rather than a filter and returns zero results when supplied alone.",
"properties": {
"name": {
"type": "string",
"description": "Brand, DBA, or business name to resolve to operating locations."
},
"state": {
"type": "string",
"description": "Optional two-letter US state code. Applied by Deepline as a post-response filter on the resolved location address, because Enigma matches brand names nationwide.",
"minLength": 2,
"maxLength": 2
},
"period": {
"type": "string",
"description": "Reporting window for the returned quantities.",
"default": "12m",
"enum": [
"1m",
"3m",
"12m"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `result.data` | `object` | Yes | | GraphQL envelope. Enigma always returns a `data` wrapper; `search` is a list of union members narrowed to OperatingLocation by the pinned query. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "GraphQL envelope. Enigma always returns a `data` wrapper; `search` is a list of union members narrowed to OperatingLocation by the pinned query.",
"properties": {
"data": {
"type": "object",
"properties": {
"search": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Enigma operating location identifier.",
"format": "uuid"
},
"addresses": {
"type": "object",
"description": "Relay-style connection. Deepline reads the first edge only.",
"properties": {
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node": {
"type": "object",
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"cardTransactions": {
"type": "object",
"description": "Relay-style connection of card-spend metrics. One edge per quantityType x period combination.",
"properties": {
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node": {
"type": "object",
"description": "One card-spend metric for one period. Enigma returns every quantityType/period pair as a separate node; Deepline selects the requested period and normalizes the set into scalar fields.",
"properties": {
"quantityType": {
"type": "string",
"description": "Metric name. Verified live 2026-08-11.",
"enum": [
"card_revenue_amount",
"avg_transaction_size",
"card_transactions_count",
"card_revenue_yoy_growth",
"card_revenue_prior_period_growth",
"card_customers_average_daily_count",
"refunds_amount",
"has_transactions"
]
},
"period": {
"type": "string",
"enum": [
"1m",
"3m",
"12m"
]
},
"projectedQuantity": {
"type": [
"number",
"null"
],
"description": "Projected value for the quantity over the period. Growth types are expressed as a ratio, not a percentage: 0.0721 means +7.21%.",
"format": "double"
},
"periodStartDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"periodEndDate": {
"type": [
"string",
"null"
],
"format": "date"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute enigma_brand_revenue_search --payload '{
"name": "string"
}' --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: `fixed` (per call).
* Estimated Deepline credits: `0.7` per pricing unit.
* Billing mode: `post_deduct`.