Save discovery plan

curl --request PUT \
  --url https://api.sigmora.org/v1/discovery/configs/{brandId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Budgeting habits that help first-job earners build an emergency fund.",
  "keywords": [
    "first salary budget",
    "emergency fund tips"
  ],
  "excludeKeywords": [
    "crypto signals"
  ],
  "enabled": true,
  "platforms": [
    "youtube_shorts",
    "tiktok",
    "reddit"
  ],
  "regionCode": "KE",
  "discoveryIntervalMinutes": 1440
}
'

import requests

url = "https://api.sigmora.org/v1/discovery/configs/{brandId}"

payload = {
    "intent": "Budgeting habits that help first-job earners build an emergency fund.",
    "keywords": ["first salary budget", "emergency fund tips"],
    "excludeKeywords": ["crypto signals"],
    "enabled": True,
    "platforms": ["youtube_shorts", "tiktok", "reddit"],
    "regionCode": "KE",
    "discoveryIntervalMinutes": 1440
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    intent: 'Budgeting habits that help first-job earners build an emergency fund.',
    keywords: ['first salary budget', 'emergency fund tips'],
    excludeKeywords: ['crypto signals'],
    enabled: true,
    platforms: ['youtube_shorts', 'tiktok', 'reddit'],
    regionCode: 'KE',
    discoveryIntervalMinutes: 1440
  })
};

fetch('https://api.sigmora.org/v1/discovery/configs/{brandId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "config": {
    "id": "<string>",
    "contentBrandId": "<string>",
    "enabled": true,
    "platforms": [
      "youtube_shorts"
    ],
    "regionCode": "<string>",
    "discoveryIntervalMinutes": 0,
    "refreshIntervalMinutes": 0,
    "minimumSourceCount": 0,
    "notification": {
      "inApp": true,
      "email": true,
      "minimumScore": 50,
      "minimumEvidence": 10
    },
    "searchDemand": {
      "enabled": true,
      "maxQueries": 2
    },
    "queryPlan": {
      "version": "<string>",
      "primaryThemeId": "<string>",
      "themeIds": [
        "<string>"
      ],
      "seedTerms": [
        "<string>"
      ],
      "queries": [
        {
          "platform": "youtube_shorts",
          "terms": [
            "<string>"
          ],
          "intents": [
            "momentum"
          ]
        }
      ],
      "compiledAt": "2023-11-07T05:31:56Z",
      "basis": [
        "<string>"
      ],
      "intent": "<string>",
      "excludeKeywords": [
        "<string>"
      ]
    },
    "lastDiscoveryAt": "2023-11-07T05:31:56Z",
    "lastRefreshAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "health": {
    "status": "ready",
    "readySources": 0,
    "configuredSources": 0,
    "sources": [
      {
        "platform": "youtube_shorts",
        "status": "ready",
        "reason": "<string>",
        "queryMode": "provider-query",
        "lastDiscoveryAt": "2023-11-07T05:31:56Z",
        "lastRefreshAt": "2023-11-07T05:31:56Z"
      }
    ],
    "limitation": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

PUT

discovery

configs

{brandId}

Save discovery plan

curl --request PUT \
  --url https://api.sigmora.org/v1/discovery/configs/{brandId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Budgeting habits that help first-job earners build an emergency fund.",
  "keywords": [
    "first salary budget",
    "emergency fund tips"
  ],
  "excludeKeywords": [
    "crypto signals"
  ],
  "enabled": true,
  "platforms": [
    "youtube_shorts",
    "tiktok",
    "reddit"
  ],
  "regionCode": "KE",
  "discoveryIntervalMinutes": 1440
}
'

import requests

url = "https://api.sigmora.org/v1/discovery/configs/{brandId}"

payload = {
    "intent": "Budgeting habits that help first-job earners build an emergency fund.",
    "keywords": ["first salary budget", "emergency fund tips"],
    "excludeKeywords": ["crypto signals"],
    "enabled": True,
    "platforms": ["youtube_shorts", "tiktok", "reddit"],
    "regionCode": "KE",
    "discoveryIntervalMinutes": 1440
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    intent: 'Budgeting habits that help first-job earners build an emergency fund.',
    keywords: ['first salary budget', 'emergency fund tips'],
    excludeKeywords: ['crypto signals'],
    enabled: true,
    platforms: ['youtube_shorts', 'tiktok', 'reddit'],
    regionCode: 'KE',
    discoveryIntervalMinutes: 1440
  })
};

fetch('https://api.sigmora.org/v1/discovery/configs/{brandId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "config": {
    "id": "<string>",
    "contentBrandId": "<string>",
    "enabled": true,
    "platforms": [
      "youtube_shorts"
    ],
    "regionCode": "<string>",
    "discoveryIntervalMinutes": 0,
    "refreshIntervalMinutes": 0,
    "minimumSourceCount": 0,
    "notification": {
      "inApp": true,
      "email": true,
      "minimumScore": 50,
      "minimumEvidence": 10
    },
    "searchDemand": {
      "enabled": true,
      "maxQueries": 2
    },
    "queryPlan": {
      "version": "<string>",
      "primaryThemeId": "<string>",
      "themeIds": [
        "<string>"
      ],
      "seedTerms": [
        "<string>"
      ],
      "queries": [
        {
          "platform": "youtube_shorts",
          "terms": [
            "<string>"
          ],
          "intents": [
            "momentum"
          ]
        }
      ],
      "compiledAt": "2023-11-07T05:31:56Z",
      "basis": [
        "<string>"
      ],
      "intent": "<string>",
      "excludeKeywords": [
        "<string>"
      ]
    },
    "lastDiscoveryAt": "2023-11-07T05:31:56Z",
    "lastRefreshAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "health": {
    "status": "ready",
    "readySources": 0,
    "configuredSources": 0,
    "sources": [
      {
        "platform": "youtube_shorts",
        "status": "ready",
        "reason": "<string>",
        "queryMode": "provider-query",
        "lastDiscoveryAt": "2023-11-07T05:31:56Z",
        "lastRefreshAt": "2023-11-07T05:31:56Z"
      }
    ],
    "limitation": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Path Parameters

brandId

string

required

The Brand whose discovery plan this is. GET /v1/brands lists them.

Required string length: 1 - 200

Example:

"brd_4b81"

Body

application/json

intent

string

The channel-specific content opportunity the monitor should discover.

Required string length: 10 - 500

keywords

string[]

Optional channel-specific search phrases. Send at most 12.

Maximum array length: 12

Required string length: 2 - 120

excludeKeywords

string[]

Optional phrases that exclude irrelevant search results. Send at most 20.

Maximum array length: 20

Required string length: 2 - 120

enabled

boolean

Whether scheduled discovery runs should occur. Defaults to false when first created, so saving a plan does not start automation unexpectedly.

platforms

enum<string>[]

Sources to watch. Accepted values are shown below; omit to keep the saved selection.

Required array length: 1 - 10 elements

Available options:

youtube_shorts,

instagram_reels,

facebook_reels,

tiktok,

twitter,

reddit,

news,

medium,

google_news,

google_web

regionCode

string

Two-letter ISO 3166-1 country code used for regional results.

Required string length: 2

Example:

"US"

discoveryIntervalMinutes

integer

Minutes between full discovery runs. 15 to 43,200. Scheduled discovery runs at most every 360 minutes, so a shorter interval runs at that floor. Scheduled discoveries are bounded at 32 a day across all plans by default, spread evenly over the UTC day; POST /v1/discovery/runs runs one now.

Required range: 15 <= x <= 43200

refreshIntervalMinutes

integer

Minutes between metric refreshes for previously found content. 15 to 43,200. Scheduled refreshes run at most every 30 minutes, so a shorter interval runs at that floor. Scheduled refreshes are bounded at 96 a day across all plans by default (plans on one primary theme share a refresh), spread evenly over the UTC day.

Required range: 15 <= x <= 43200

minimumSourceCount

integer

Distinct selected sources required before a new finding may notify. Defaults to two when possible.

Required range: 1 <= x <= 10

notification

object

Channel-owned in-app/email notification preferences. Email is opt-in.

Show child attributes

searchDemand

object

Optional bounded YouTube public-search sampling. Scores are directional, not search-volume forecasts.

Show child attributes

Response

Success.

success

boolean

required

config

object

required

Saved discovery settings and their compiled query plan.

Show child attributes

health

object

required

Source readiness and collection freshness.

Show child attributes

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Save discovery plan

Authorizations

Path Parameters

Body

Response