Skip to main content
GET
/
v1
/
dashboard
Get dashboard data
curl --request GET \
  --url https://api.firstanswer.ai/v1/dashboard/ \
  --header 'api-key: <api-key>'
{
  "data": {
    "total_prompts": 123,
    "total_responses": 123,
    "total_brand_mentions": 123,
    "brand_mention_rate": "<string>",
    "average_brand_sentiment": "<string>",
    "competitors_count": 123,
    "brands_ranking": [
      {
        "name": "<string>",
        "mentions": 123,
        "own_brand": true,
        "ranking": 123,
        "visibility": "<string>",
        "average_position": "<string>",
        "average_sentiment": "<string>"
      }
    ],
    "top_ranked_prompts": [
      {
        "id": 123,
        "brand_mentions": 123,
        "prompt": "<string>",
        "visibility": "<string>"
      }
    ],
    "lowest_ranked_prompts": [
      {
        "id": 123,
        "brand_mentions": 123,
        "prompt": "<string>",
        "visibility": "<string>"
      }
    ]
  }
}

Authorizations

api-key
string
header
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

group_id
integer | null
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