Skip to main content
GET
/
responses
List Responses
curl --request GET \
  --url https://server.promptwatch.com/api/v2/responses \
  --header 'X-API-Key: <api-key>'
{
  "responses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": "<string>",
      "model": "<string>",
      "provider": "<string>",
      "mentionedOurBrand": true,
      "competitorMentions": [
        "<string>"
      ],
      "citationCount": 123,
      "prompt": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prompt": "<string>",
        "type": "ORGANIC",
        "llmMonitor": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        },
        "intent": "BRANDED"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "visibilityScore": 123,
      "sentimentScore": 123,
      "sentiment": "POSITIVE",
      "toneOfVoice": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123,
  "totalPages": 123
}

Authorizations

X-API-Key
string
header
required

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

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
size
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
llmMonitorId
string<uuid>

Filter by specific monitor ID

promptId
string<uuid>

Filter by specific prompt ID

query
string

Search query for response content (full-text search)

model
string

Filter by specific model

sentiment
enum<string>[]

Filter by sentiment

Available options:
POSITIVE,
NEGATIVE,
NEUTRAL
mentionedOurBrand
boolean

Filter by whether the brand was mentioned

from
string<date-time>

Filter responses created after this date

until
string<date-time>

Filter responses created before this date

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
visibilityScore,
sentimentScore
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Default Response

responses
object[]
required

Array of responses

total
number
required

Total number of responses matching the query

page
number
required

Current page number

size
number
required

Number of items per page

totalPages
number
required

Total number of pages