Skip to main content
GET
Get a keyword

Authorizations

x-api-key
string
header
required

API key created from the Nephia dashboard for your Account.

Path Parameters

id
string<uuid>
required

Response

Keyword detail

id
string
required
name
string
required
kind
enum<string>
required
Available options:
catalog,
listening,
visibility
globalCriteria
object
required
refreshIntervalSeconds
number
required
sources
object[]
required
webhookUrl
string | null
required
webhookMode
enum<string>
required
Available options:
all,
rules
webhookEvents
enum<string>[]
required
Available options:
keyword.alert_fired,
keyword.report_ready,
keyword.paused,
keyword.resumed,
channel.disabled
aiEnabled
boolean
required
aiPreset
string | null
required
aiPrompt
string | null
required
aiStep
object | null
required
sentimentEnabled
boolean
required
coBrandsEnabled
boolean
required
subjectRole
enum<string>
required
Available options:
own,
competitor,
topic
color
enum<string> | null
required
Available options:
keyword-1,
keyword-2,
keyword-3,
keyword-4,
keyword-5,
keyword-6,
keyword-7,
keyword-8,
null
relevanceContext
string | null
required
muteRules
any[]
required
vipAuthors
any[]
required
rules
any[]
required
schedule
object | null
required
isActive
boolean
required
pausedReason
string | null
required
createdAt
string
required
updatedAt
string
required
channels
object[]
required