Skip to main content
POST
/
monitors
Create Monitor
curl --request POST \
  --url https://server.promptwatch.com/api/v2/monitors \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "models": [
    "<string>"
  ],
  "description": "<string>",
  "languageCode": "en-US",
  "countryCode": "US",
  "stateCode": "<string>",
  "cityCode": "<string>",
  "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "initialPrompts": [
    {
      "prompt": "<string>",
      "type": "ORGANIC",
      "intent": "INFORMATIONAL",
      "keywords": [
        "<string>"
      ]
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "active": true,
  "models": [
    "<string>"
  ],
  "languageCode": "<string>",
  "countryCode": "<string>",
  "promptCount": 123,
  "responseCount": 123,
  "averageVisibility": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "responseCountInRange": 123,
  "personaName": "<string>",
  "personaDescription": "<string>",
  "personaAgeRange": "<string>",
  "personaEducationLevel": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Body

application/json
​
name
string
required

Monitor name

Minimum string length: 1
​
models
string[]
required

List of LLM models to monitor

Minimum array length: 1
​
description
string | null

Monitor description

​
languageCode
string
default:en-US

Language code

​
countryCode
string
default:US

Country code

​
stateCode
string | null

State code

​
cityCode
string | null

City code

​
personaId
string<uuid> | null

Persona ID

​
initialPrompts
object[]

Initial prompts to create with the monitor

Response

Default Response

​
id
string<uuid>
required

Monitor unique identifier

​
name
string
required

Monitor name

​
active
boolean
required

Whether the monitor is active

​
models
string[]
required

List of LLM models being monitored

​
languageCode
string
required

Language code for the monitor

​
countryCode
string
required

Country code for the monitor

​
promptCount
number
required

Number of prompts in this monitor

​
responseCount
number
required

Total number of responses across all prompts

​
averageVisibility
number
required

Average visibility score for the monitor within the selected date range

​
createdAt
string<date-time>
required

Monitor creation timestamp

​
updatedAt
string<date-time>
required

Monitor last update timestamp

​
description
string | null

Monitor description

​
responseCountInRange
number

Number of responses created within the selected date range

​
personaName
string | null

Persona name used for the monitor

​
personaDescription
string | null

Persona description

​
personaAgeRange
string | null

Persona age range

​
personaEducationLevel
string | null

Persona education level