prism

Campaign tracker: pre/during/post volume lift, cross-platform engagement, and ranked top amplifiers for a hashtag or phrase.

Fans out to content_analysis phrase-trends (pre/during/post windows), search/everywhere (consuming items_by_source for real per-platform engagement, not the capped fused items), and tiktok/youtube search for amplifier discovery, then folds them into a lift report (volume lift %, sustained-floor check, ranked amplifiers). YouTube amplifiers are undated in fusion: pass include=amplifier_dates to date the top ones via direct youtube/video calls. Supply hashtag OR phrase plus window_start; window_end defaults to today. Each amplifier also carries a judged mention label (is the post about the campaign, or the brand you name), and top_amplifiers_about_brand repeats the engagement ranking without the posts judged to be about something else; top_amplifiers is unchanged. legs[] reports each leg; losing the CA timeline or the everywhere engagement spine refunds half. Flat 35 credits.

get/prism/campaign

Request

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

Query parameters

hashtagstring

The campaign hashtag (with or without #). One of hashtag or phrase is required. (one of: hashtag, phrase; at least one required)

phrasestring

A campaign slogan/phrase instead of a hashtag. One of hashtag or phrase is required. (one of: hashtag, phrase; at least one required)

window_startstring

Campaign launch date (YYYY-MM-DD): the pre/during boundary. Optional; defaults to 30 days ago.

window_endstring

Campaign end date (YYYY-MM-DD): the during/post boundary. Defaults to today.

pre_daysinteger

Baseline days before window_start for lift measurement (1-90, default 14).

post_daysinteger

Days after window_end for the post window (0-90, default 14; 0 = no post window).

includestring

Set amplifier_dates to date YouTube amplifiers via direct youtube/video calls (undated in fusion).

brandstring

Optional brand the amplifier posts are judged against. Defaults to the hashtag or phrase.

brand_descriptionstring

Optional one-line description of the brand or campaign, 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/campaign",
  "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.