Skip to main content
GET
Content gap for a run (all topics)

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

runId
string<uuid>
required

UUID of the run whose content gap to retrieve.

Response

runId
string
required

The run whose content gap this describes.

Example:

"019dd32e-b19e-7956-88f6-4b9a877f3697"

topicsStatus
enum<string>
required

Clustering status of the run. Topics only exist once this is ready; poll until then.

Available options:
pending,
clustering,
ready,
failed
Example:

"ready"

totalCitations
number
required

Sum of citationCount across all topics — the denominator for citationShare.

Example:

691

analyzedSources
number
required

Number of sources the run analyzed for topics. The difference vs the sum of topic sizes is sources that did not group into any topic.

Example:

96

ownedDomainsMapped
boolean
required

Whether the project has any source domains mapped as owned. When false, no topic can be marked covered — every row reads as a content gap regardless of the data. Prompt the user to map their brand’s domains.

Example:

true

competitorDomainsMapped
boolean
required

Whether the project has any source domains mapped as competitor. When false, competitorPresent is always false.

Example:

true

topics
object[]
required

Topics ordered by citationShare descending. Use isContentGap to surface/filter the gaps among the top-cited topics.