# content_analysis.summary

**beta** **70 credits** **needs a pack**

Aggregate web mentions of a keyword: volume, rank, top domains, sentiment, page types, countries, languages.

`GET /v1/content_analysis/summary`

> [!NOTE] **Beta.** This endpoint has not yet been verified against the live source, so fields may be missing or differ until it becomes stable. Failed calls are refunded.

> [!NOTE] **Needs a pack.** Needs a purchased pack and a verified email; free credits do not reach this endpoint. See [pricing](https://onekey.dev/pricing).

## What you get

One Content Analysis record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

**Also known as:** `/content_analysis/summary` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## What it costs

- **70 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `keyword` | string | yes | (required) | Brand or term; wrap in escaped double quotes for an exact phrase | max 100 chars; must match `[^\r\n]{2,100}`; trimmed, repeated spaces collapsed |

## Request

```bash
curl "https://api.onekey.dev/v1/content_analysis/summary?keyword=logitech%20mouse" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/content_analysis/summary",
    params={"keyword": "logitech mouse"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ keyword: "logitech mouse" });
const res = await fetch(`https://api.onekey.dev/v1/content_analysis/summary?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Content Analysis response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "ext": {
      "totalCount": 128450,
      "rank": 560,
      "topDomains": [
        {
          "domain": "example-news.test",
          "count": 4200
        },
        {
          "domain": "example-blog.test",
          "count": 2100
        }
      ],
      "sentimentConnotations": {
        "anger": 3100,
        "happiness": 21000,
        "love": 9800,
        "sadness": 2200,
        "share": 5400,
        "fun": 7700
      },
      "connotationTypes": {
        "positive": 64000,
        "negative": 12000,
        "neutral": 52450
      },
      "textCategories": [
        {
          "category": 10021,
          "count": 9000
        }
      ],
      "pageTypes": {
        "ecommerce": 800,
        "news": 56000,
        "blogs": 40000
      },
      "countries": {
        "US": 70000,
        "GB": 11000
      },
      "languages": {
        "en": 110000,
        "de": 4000
      }
    }
  },
  "metadata": {
    "platform": "content_analysis",
    "endpoint": "summary",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 70,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `total_count` | `ext.totalCount` | `toNumber` |
| `rank` | `ext.rank` | `toNumber` |
| `top_domains` | `ext.topDomains` | - |
| `sentiment_connotations` | `ext.sentimentConnotations` | - |
| `connotation_types` | `ext.connotationTypes` | - |
| `text_categories` | `ext.textCategories` | - |
| `page_types` | `ext.pageTypes` | - |
| `countries` | `ext.countries` | - |
| `languages` | `ext.languages` | - |

## Caching and freshness

- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
- A "not found" is remembered for 2 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: beta (not yet verified against the live source).