prism

Brand mention volume time-series, sentiment split, top sources, and recent mentions for one keyword.

Fans out to content_analysis summary, phrase-trends, and search in parallel, then folds them into one envelope with a computed volume/sentiment trajectory (OLS slope + a noise-aware direction) and an optional LLM digest (include=digest). Sentiment is NLP-derived (content_analysis), and mention freshness lags the live web by days: computed.sentiment_provenance names the exact leg the split came from and states that the values are third-party model probabilities, not human-labelled ground truth, so you can audit them against recent_mentions yourself. Each recent_mentions row also carries a judged mention label (nullable): about_brand (a probability, so a name collision such as the notion of time for Notion reads near 0), sentiment_level 0 to 4 toward that brand, sarcastic, aspect and first_hand; computed.mention_labels counts them in code (rows not about the brand with their ids, positive/neutral/negative, and negative mentions by aspect) and is scoped to that recent sample, not to total_count. If the labels cannot be produced the rest of the response is unchanged and _warnings says mention_labels_unavailable. The price is the same either way. The computed block carries stable keys + a methodology_version so a monitor can diff runs. legs[] reports each leg's status, cost, and latency; if one of the three data legs fails the call still returns a degraded result, and a strict-majority failure refunds half.

get/prism/brand-mentions

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/prism/brand-mentions
  • Auth: API key in header x-api-key

Query parameters

keywordstring required

The brand or term to track. Wrap in quotes for exact-phrase semantics.

date_fromstring required

Window start (YYYY-MM-DD). Required by the trend leg.

date_tostring

Window end (YYYY-MM-DD). Defaults to the latest crawl.

date_group'day' | 'week' | 'month'

Trend bucket size: day (default), week, or month.

page_type'ecommerce' | 'news' | 'blogs' | 'message-boards' | 'organization'

Optional surface filter: ecommerce, news, blogs, message-boards, or organization.

includestring

Set digest to add an LLM narrative summary leg.

brand_descriptionstring

Optional one-line description of the brand, used to tell it apart from other things with the same name.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/brand-mentions",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.