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

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.

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#

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

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

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. 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; 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 for the full list and retry guidance.

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