me

Update a source (display name, pause, resume, etc.)

patch/api/me/sources/{id}

Request

  • Base URL: https://api.signalraven.ai
  • URL: https://api.signalraven.ai/api/me/sources/{id}
  • Auth: none declared

Path parameters

idstring uuid required

Request body

sourceType'own_company' | 'competitor_company' | 'competitor_company_broad' | 'competitor_employee' | 'keyword_search' | 'industry_search' | 'mention_tracking' | 'hashtag_search' | 'target_person' | 'event_search' | 'poster_search'
linkedinUrlstring
displayNamestring
priorityinteger
isActiveboolean
metadataobject
topicFilterstring nullable
searchQuerystring nullable
industryCodesstring nullable

Response

Updated source

idstring uuid required

Source ID

customerIdstring uuid required
sourceType'own_company' | 'competitor_company' | 'competitor_company_broad' | 'competitor_employee' | 'keyword_search' | 'industry_search' | 'mention_tracking' | 'hashtag_search' | 'target_person' | 'event_search' | 'poster_search' required

Source type classification

linkedinUrlstring required
displayNamestring nullable required
priorityinteger required
isActiveboolean required
metadataobject nullable required
topicFilterstring nullable required
searchQuerystring nullable required
industryCodesstring nullable required
lastSeenPostIdstring nullable required

Most recent post ID seen during discovery

lastDiscoveryAtstring date-time nullable required
createdAtstring date-time required
countsTowardCapboolean
inactiveReasonstring nullable
lastCheckedAtstring date-time nullable

target_person only: when the weekly check last ran (every 30 days after a scraper-error streak). lastDiscoveryAt moves on every daily poll, including days no check was due. null for other source types and until the first check completes.

status'producing' | 'watching' | 'slow' | 'paused' | 'error'

Computed source health badge — derived portal-side

strengthScorenumber

Relevance rate 0-1, shown as "Relevance rate" on the Sources page: the share of the source's posts in the window that passed the relevance check (qualified, harvesting, or closed after max harvests or expiry), archived posts excluded. Not a signal measure.

sparklineinteger[]

30 daily counts of signals attributed to this source (oldest → newest)

totalPostsinteger

Watched posts in window

qualifiedPostsinteger

Posts in qualified or harvesting lifecycle

avgRelevanceScorenumber nullable

Avg watched_posts.relevance_score (1-5; lower = more relevant)

totalLikesinteger
totalCommentsinteger
signalCountinteger

Signals attributed to this source within the window

creditsnumber

Credits this source spent within the window (credit_transactions.source_id, numeric to scale 4). GET /api/me/sources only.

Example response

{
  "linkedinUrl": "https://www.linkedin.com/company/acme/",
  "displayName": "Acme Corp",
  "priority": 3
}

Changes

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