> ## Documentation Index > Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt > Use this file to discover all available pages before exploring further. # Read Topic Monitor > Read one channel-owned Topic Monitor configuration. ## OpenAPI ````yaml /openapi.json get /v1/topic-monitors/{brandId} openapi: 3.1.0 info: title: Sigmora API version: 1.0.0 description: >- The priced, versioned public API. Every call authenticates with a workspace API key (`Authorization: Bearer sk_live_…`), names the project it files its output under, and reports what it cost. `GET /v1/capabilities` answers what this deployment can serve right now and at what price; anything it reports as unavailable answers 503 `capability_unavailable` rather than 404. servers: - url: https://api.sigmora.org security: - bearerAuth: [] tags: - name: Meta description: What this deployment serves, what it costs, and what you have spent. - name: Projects description: The container every capability files its output under. - name: Sessions description: Durable bindings between an external harness session and one project. - name: Assets description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.' - name: Jobs description: Where every asynchronous capability is collected, whatever produced it. - name: Text description: Scripts, research, articles, translation and question sets. - name: Video description: Narrated renders, footage edits, shorts and moment selection. - name: UGC description: >- Creator-led vertical videos: AI creators, their faces and voices, frames and clips. - name: Editing description: >- Sigma, the editor: conversational turns, granular transcript edits, approvals. - name: 3D description: Animated 3D renders from a description or a photograph. - name: Image description: Thumbnails, sized for the platform they are posted to. - name: Audio description: Generated music and audio engineering in Audiotool projects. - name: Publishing description: Connected destinations and queued posts. - name: Webhooks description: Signed, at-least-once delivery of job and publishing events. - name: Workflows description: Context snapshots, versioned recipes, costed proposals and their runs. - name: Agents description: Describe an outcome and let a bounded plan of capabilities run. - name: Research description: >- Observed hooks, creator outliers and production briefs from saved analyses. - name: Themes description: The canonical content taxonomy, and the niche profiles built on it. - name: Signals description: Evidence-backed trends and scored viral content. - name: Discovery description: Compiled watch plans, their runs, and source freshness. - name: Watchlist description: 'Accounts you watch: their usual reach and the posts that beat it.' - name: Performance description: Your own channels' videos against their usual, and fixes to live videos. - name: Autopilot description: The durable trend-to-distribution workflow and its checkpoints. - name: Campaigns description: Distribution records shared by the API, the dashboard and autopilot. - name: Brands description: >- Cross-platform identities with their own voice, rules and publishing commitments. - name: Products description: What a campaign promotes. paths: /v1/topic-monitors/{brandId}: get: tags: - Discovery summary: Read Topic Monitor description: Read one channel-owned Topic Monitor configuration. operationId: getTopicMonitorsByBrandId parameters: - name: brandId in: path required: true description: The Brand whose discovery plan this is. GET /v1/brands lists them. schema: type: string minLength: 1 maxLength: 200 description: The Brand whose discovery plan this is. GET /v1/brands lists them. examples: - brd_4b81 responses: '200': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true config: $ref: '#/components/schemas/DiscoveryPlan' description: Saved discovery settings and their compiled query plan. required: - success - config additionalProperties: {} '400': description: 'Failure. `code` is one of: invalid_request.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: 'Failure. `code` is one of: unauthorized.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: 'Failure. `code` is one of: forbidden, origin_not_allowed.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'Failure. `code` is one of: not_found.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: 'Failure. `code` is one of: rate_limited.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'Failure. `code` is one of: upstream_error, internal_error.' content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- Failure. `code` is one of: capability_unavailable, upstream_unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: DiscoveryPlan: type: object properties: id: type: string description: Discovery configuration id. contentBrandId: type: string description: Brand this configuration belongs to. enabled: type: boolean description: Whether scheduled runs are enabled. platforms: type: array items: type: string enum: - youtube_shorts - instagram_reels - facebook_reels - tiktok - twitter - reddit - news - medium - google_news - google_web description: Configured source platforms. regionCode: type: string description: Two-letter regional country code. discoveryIntervalMinutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minutes between full discovery runs. refreshIntervalMinutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Minutes between metric refreshes. minimumSourceCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Distinct configured sources required before a new discovery may alert. notification: type: object properties: inApp: type: boolean description: >- Save the channel-owned discovery notice and dispatch browser/mobile notification. email: type: boolean description: Send a batched owner email when a new qualifying signal appears. minimumScore: type: integer minimum: 0 maximum: 100 minimumEvidence: type: integer minimum: 1 maximum: 20 required: - inApp - email - minimumScore - minimumEvidence description: Channel-scoped notification choices. searchDemand: type: object properties: enabled: type: boolean description: >- Use a bounded public YouTube search sample for directional demand. maxQueries: type: integer minimum: 1 maximum: 4 required: - enabled - maxQueries description: Provider-quota guard for directional search-demand enrichment. queryPlan: $ref: '#/components/schemas/DiscoveryQueryPlan' description: Stored watch plan used by discovery runs. lastDiscoveryAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' description: Last full run time, or null before the first run. lastRefreshAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' description: Last metric refresh time, or null before the first refresh. createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ required: - id - contentBrandId - enabled - platforms - regionCode - discoveryIntervalMinutes - refreshIntervalMinutes - minimumSourceCount - notification - searchDemand - queryPlan - lastDiscoveryAt - lastRefreshAt - createdAt - updatedAt additionalProperties: {} description: Saved discovery settings and their compiled query plan. Error: type: object required: - success - error - code properties: success: const: false error: type: string description: >- Human-readable. Copy may change between releases — do not match on it. code: type: string enum: - invalid_request - unauthorized - forbidden - origin_not_allowed - not_found - conflict - payload_too_large - insufficient_credits - budget_capped - content_not_cleared - rate_limited - capability_unavailable - upstream_unavailable - upstream_error - internal_error description: Stable machine-readable cause. Branch on this. details: description: Optional structured context, e.g. the credits shortfall. requestId: type: string description: >- Identifies this request in our logs. Include it when you contact support. timestamp: type: string format: date-time description: When the failure was produced. DiscoveryQueryPlan: type: object properties: intent: type: string excludeKeywords: type: array items: type: string version: type: string description: Query-plan compiler version. primaryThemeId: type: string description: Brand theme the plan is centered on. themeIds: type: array items: type: string description: Canonical themes the plan watches. seedTerms: type: array items: type: string description: Terms compiled from the Brand profile. queries: type: array items: type: object properties: platform: type: string enum: - youtube_shorts - instagram_reels - facebook_reels - tiktok - twitter - reddit - news - medium - google_news - google_web description: Source this query runs against. terms: type: array items: type: string description: Search/watch terms sent to or applied for the source. intents: type: array items: type: string enum: - momentum - news - controversy - questions - competitors description: >- Signals this query is intended to find. `competitors` appears only on legacy plans; new topic-monitor plans never use it. required: - platform - terms - intents additionalProperties: {} description: Platform-specific watch queries. compiledAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: When this reproducible plan was compiled. basis: type: array items: type: string description: Brand fields and taxonomy context used to compile it. required: - version - primaryThemeId - themeIds - seedTerms - queries - compiledAt - basis additionalProperties: {} description: Stored watch plan used by discovery runs. securitySchemes: bearerAuth: type: http scheme: bearer description: A workspace API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.