Skip to main content
GET
/
v1
/
monitored-prompts
/
{monitored_prompt_id}
Get monitored prompt details
curl --request GET \
  --url https://api.firstanswer.ai/v1/monitored-prompts/{monitored_prompt_id}/ \
  --header 'api-key: <api-key>'
{
  "data": {
    "id": 123,
    "prompt": "<string>",
    "total_responses": 123,
    "total_brand_mentions": 123,
    "brand_mention_rate": "<string>",
    "brand_average_position": "<string>",
    "time_series_data": [
      {
        "date": "2023-12-25",
        "brands": [
          {
            "name": "<string>",
            "mention_rate": "<string>",
            "average_sentiment": "<string>",
            "own_brand": true
          }
        ]
      }
    ],
    "next_run_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

api-key
string
header
required

Path Parameters

monitored_prompt_id
integer
required

Query Parameters

brand_id
integer
required
start_date
string<date>
required

Start date in YYYY-MM-DD format

end_date
string<date>
required

End date in YYYY-MM-DD format

ai_model
enum<string>
  • chat_gpt - Chat Gpt
  • perplexity - Perplexity
  • bing_copilot - Bing Copilot
  • google_ai - Google Ai
  • gemini - Gemini
  • grok - Grok
  • google_ai_mode - Google Ai Mode
Available options:
chat_gpt,
perplexity,
bing_copilot,
google_ai,
gemini,
grok,
google_ai_mode
Minimum string length: 1

Response

Success

data
object
required