Skip to main content
POST
/
prompt-report
Prompt Report
curl --request POST \
  --url https://app.mentionpilot.ai/api/v1/prompt-report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt_id": 42,
  "date": {
    "from": "2026-01-01",
    "to": "2026-05-07"
  },
  "ai_agent": [
    "chatgpt"
  ],
  "limit": 20
}
'
{
  "success": true,
  "report": [
    {
      "id": 42,
      "prompt": "Best CRM for small teams",
      "active": "Y",
      "created_at": "2026-03-15T09:00:00.000000+00:00",
      "brand_id": 1,
      "brand": "MentionPilot",
      "total_responses": 24,
      "visibility": 75,
      "sentiment": 82,
      "position": 2.3
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://help.mentionpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Report parameters

prompt_id
integer

ID of a specific prompt. Omit to return all prompts.

Example:

42

date
object

Optional date range filter.

ai_agent
string[]

Filter by AI agent(s). Omit to include all agents.

Example:
["chatgpt", "gemini"]
limit
integer

Maximum number of prompts to return. Omit to return all.

Example:

20

Response

Prompt report

success
boolean
Example:

true

report
object[]