# Compute GEO Index

`POST https://api.dataforgeo.dev/v1/geo/index` · Pro / Scale / Enterprise

Computes GEO Index KPIs on top of /v1/geo/answer results. Pro, Scale and Enterprise. Starter gets 403 plan_not_allowed.

### Parameters

Same parameters as /v1/geo/answer, with brand required, plus:

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `brand` | string | Yes | Brand to compute KPIs for |
| `tag` | string | No | Custom grouping tag, e.g. osaka-family-q4. /summary aggregates by it |
| `intent` | string | No | Prompt intent: compare, cost, discover, evaluate, howto, recommend |
| `persona` | string | No | Who is asking, free text, e.g. families with kids |

### Example request

```bash
curl https://api.dataforgeo.dev/v1/geo/index \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "prompt": "大阪带孩子住哪里方便？",
    "engines": [
      "chatgpt",
      "perplexity",
      "grok"
    ],
    "brand": "晓宅",
    "tag": "osaka-family-q4",
    "intent": "recommend",
    "persona": "带孩子的家庭",
    "location": "JP",
    "language": "zh-CN"
  }'
```

### Example response

```json
{
  "request_id": "req_91d0b3",
  "brand": "晓宅",
  "tag": "osaka-family-q4",
  "credits_used": 6,
  "answers": [
    "…与 /v1/geo/answer 相同…"
  ],
  "kpis": {
    "visibility": {
      "value": 0.667,
      "numerator": 2,
      "denominator": 3,
      "samples": 3
    },
    "share_of_voice": {
      "value": 0.25,
      "numerator": 2,
      "denominator": 8,
      "samples": 3
    },
    "top_rate": {
      "value": 0,
      "numerator": 0,
      "denominator": 3,
      "samples": 3
    },
    "competitor_gap": {
      "value": -1.33,
      "samples": 3
    },
    "positive_ratio": {
      "value": 1,
      "numerator": 2,
      "denominator": 2,
      "samples": 3
    }
  },
  "kpi_tier": "pro"
}
```

- The example is 3 standard engines × 1 answer: 3 × 1 credit + 3 × 1 credit Index = 6 credits.
- kpi_tier pro returns core KPIs only; scale returns all of them.
- A single request has few samples, so treat its KPIs as indicative. Use /v1/geo/index/summary for trends and comparisons.
