Mangools/API

Get prompt detail

Get detailed metrics for a single monitoring prompt — how each configured AI model responds to it, brand mention counts, citation URLs extracted from the responses, and visibility changes over time.

Query parameters:

  • from, to — date range (YYYY-MM-DD)
  • models — optional array of model IDs to filter the metrics

Useful for rendering a prompt-level drilldown inside a monitor dashboard.

GET
/aiwatcher/prompt/{id}

Authorization

ApiKeyAuth
x-access-token<token>

API token issued for your Mangools account, sent as an API key in the x-access-token HTTP header. This is NOT a standard RFC 6750 Authorization: Bearer <token> header. Auto-generated clients should be configured to send the token in x-access-token accordingly.

In: header

Path Parameters

id*string

Prompt ID

Query Parameters

from?string

Start date for metrics (YYYY-MM-DD)

to?string

End date for metrics (YYYY-MM-DD)

models?array<string>

Filter by model IDs

Response Body

application/json

application/json

application/json

curl -X GET "https://api.mangools.com/v3/aiwatcher/prompt/string"
{
  "dateRange": {
    "from": "2024-01-01",
    "to": "2024-01-31"
  },
  "filters": {
    "models": [
      "string"
    ]
  },
  "prompt": {
    "_id": "string",
    "text": "string",
    "created_at": 0,
    "updated_at": 0
  },
  "metrics": {
    "score": {
      "value": 0,
      "change": 0
    },
    "visibility": {
      "value": 0,
      "change": 0
    },
    "position": {
      "value": 0,
      "change": 0
    },
    "citationsCount": {
      "value": 0,
      "change": 0
    },
    "citationRank": {
      "value": 0,
      "change": 0
    }
  },
  "timeSeries": [
    {
      "date": "string",
      "score": 0,
      "visibility": 0,
      "position": 0
    }
  ],
  "topBrands": [
    {
      "brand": "string",
      "rank": 0,
      "avgScore": 0,
      "frequency": 0
    }
  ],
  "topDomains": [
    {
      "domain": "string",
      "url": "string",
      "title": "string",
      "avgScore": 0,
      "frequency": 0
    }
  ]
}
{
  "error": {
    "type": "AuthError",
    "message": "Invalid API Key"
  }
}
{
  "error": {
    "type": "Error",
    "message": "Prompt not found"
  }
}