Tracked Sources

Create a tracked source

Adds a citation-classification rule. pattern is normalized to a canonical form before storage (a domain to its eTLD+1, a host to its hostname), and category is only retained for the tracked tier. New rules are always active with source_origin: manual.

post/org/tracked-sources

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Request body

patternstring required

The URL, host, or domain to match. Normalized to a canonical form on save (a domain to its eTLD+1); path_prefix and exact_url require a path.

match_type'domain' | 'host' | 'path_prefix' | 'exact_url' required

The scope the pattern matches against.

tier'primary' | 'tracked' | 'secondary' required

A cited URL's classification tier — primary (Owned: one of your own websites), tracked (Tracked: one of your configured tracked sources), or secondary (External: any other domain). The tiers partition citations, so every cited URL falls in exactly one of them.

category'affiliated_domain' | 'published_content' | 'social' | 'press'

Optional reporting label. Only retained for the tracked tier; ignored otherwise.

labelstring

Optional human-readable label for the rule.

priorityinteger

Optional tie-break priority when multiple rules match a URL.

activeboolean

Whether the rule is applied. Ignored on create (new rules are always active); on update it is the only field honored for published rules.

Response

The created tracked source.

idstring uuid required

Unique identifier of the rule.

org_idstring uuid required

The organization that owns this rule.

patternstring required

The pattern the rule matches on. Patterns written through the API are normalized; rules seeded during onboarding or from published content may carry the raw URL (the classifier normalizes at match time).

match_type'domain' | 'host' | 'path_prefix' | 'exact_url' required

The scope the pattern matches against.

tier'primary' | 'tracked' | 'secondary' required

A cited URL's classification tier — primary (Owned: one of your own websites), tracked (Tracked: one of your configured tracked sources), or secondary (External: any other domain). The tiers partition citations, so every cited URL falls in exactly one of them.

category'affiliated_domain' | 'published_content' | 'social' | 'press'

Reporting label, present only for tracked-tier rules that carry one.

labelstring

Human-readable label, when set.

priorityinteger required

Tie-break priority when multiple rules match a URL.

source_origin'manual' | 'onboarding' | 'published' required

How the rule was created — manual (via the API/editor), onboarding (seeded from the org's website), or published (auto-created when content was published; read-only except for the active toggle).

activeboolean required

Whether the rule is currently applied.

created_atstring date-time required

When the rule was created.

updated_atstring date-time required

When the rule was last updated.

Changes

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