Docs
View as Markdown

content_analysis.category_trends

beta 74 credits needs a pack

Monthly mention volume and sentiment of a product or service category since a start date.

GET /v1/content_analysis/category_trends

What you get#

A list of Content Analysis results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • 74 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#

NameTypeRequiredDefaultWhat it isConstraints
category_codestringyes(required)Numeric category code from content_analysis.categories (10021 = Apparel)max 10 chars; must match [0-9]{1,10}; trimmed
date_fromstringyes(required)Start of the date range, yyyy-mm-dd (data exists from 2022-10-31)max 10 chars; must match 20[0-9]{2}-[0-9]{2}-[0-9]{2}; trimmed

Request#

curl "https://api.onekey.dev/v1/content_analysis/category_trends?category_code=10021&date_from=2025-01-01" \
  -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": [
    {
      "content": {
        "createdAt": "2025-01-01T00:00:00Z"
      },
      "ext": {
        "totalCount": 30000,
        "rank": 700,
        "sentimentConnotations": {
          "anger": 750,
          "happiness": 5000,
          "love": 2500,
          "sadness": 600,
          "share": 1500,
          "fun": 2000
        },
        "connotationTypes": {
          "positive": 15000,
          "negative": 3000,
          "neutral": 12000
        }
      }
    },
    {
      "content": {
        "createdAt": "2025-02-01T00:00:00Z"
      },
      "ext": {
        "totalCount": 29000,
        "rank": 690,
        "sentimentConnotations": {
          "anger": 725,
          "happiness": 4833,
          "love": 2416,
          "sadness": 580,
          "share": 1450,
          "fun": 1933
        },
        "connotationTypes": {
          "positive": 14500,
          "negative": 2900,
          "neutral": 11600
        }
      }
    }
  ],
  "metadata": {
    "platform": "content_analysis",
    "endpoint": "category_trends",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 74,
    "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 pathOnekey fieldTransform
datecontent.createdAttoIsoDate
total_countext.totalCounttoNumber
rankext.ranktoNumber
sentiment_connotationsext.sentimentConnotations-
connotation_typesext.connotationTypes-

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

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