Skip to main content
The overview endpoint returns a per-prompt summary of your project’s GEO performance — visibility, sentiment, position, and which competitors appear alongside your brand. Use this to build dashboards or leaderboard views.

​
Get overview

GET /projects/{project_id}/overview
Returns aggregated metrics for all prompts in a project, with competitor mention counts per prompt.

​
Path parameters

ParamTypeDescription
project_idstring (UUID)The project ID

​
Query parameters

ParamTypeDefaultDescription
duration_daysinteger7Days to look back
date_fromstring—Start date (YYYY-MM-DD)
date_tostring—End date (YYYY-MM-DD)
prompt_typestringactiveFilter by active or suggested
providersstring—Comma-separated provider filter
curl "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/overview?duration_days=7&prompt_type=active" \
  -H "X-API-Key: tk_live_..."

​
Response

{
  "success": true,
  "data": {
    "items": [
      {
        "prompt_id": "e5f6a7b8-...",
        "content": "What is the best project management tool?",
        "prompt_type": "active",
        "created_at": "2026-01-15T10:30:00+00:00",
        "topic_id": "t1u2v3w4-...",
        "topic_name": "Product comparisons",
        "visibility": 85.0,
        "sentiment": 72.0,
        "position": 2.3,
        "volume": 42,
        "intent": "commercial",
        "cvr": 45.0,
        "competitors_mentioned": [
          {
            "competitor_id": "c1d2e3f4-...",
            "name": "Competitor A",
            "mention_count": 15,
            "icon_url": "https://logo.clearbit.com/competitor-a.com",
            "icon_urls": [
              "https://logo.clearbit.com/competitor-a.com",
              "https://www.google.com/s2/favicons?domain=competitor-a.com&sz=64"
            ]
          }
        ]
      }
    ]
  }
}

​
OverviewPromptItem fields

FieldTypeNullableDescription
prompt_idstring (UUID)NoPrompt ID
contentstringNoThe AI search query text
prompt_typestringNoactive, pending, suggested, inactive, or url_recommended
created_atstring (ISO 8601)NoPrompt creation timestamp
topic_idstring (UUID)YesTopic this prompt belongs to
topic_namestringYesTopic display name
visibilityfloatNoBrand visibility percentage (0—100) for the date range
sentimentfloatNoAverage brand sentiment score for the date range
positionfloatNoAverage brand position in responses
volumeintegerNoTotal responses collected
intentstringYesinformational, commercial, navigational, or transactional
cvrfloatYesContent visibility rate (percentage)
competitors_mentionedOverviewCompetitorMention[]NoCompetitors that appeared in responses to this prompt

​
OverviewCompetitorMention fields

FieldTypeNullableDescription
competitor_idstring (UUID)NoCompetitor ID
namestringNoCompetitor brand name as it appeared
mention_countintegerNoTotal mentions across responses for this prompt
icon_urlstringYesPrimary logo URL
icon_urlsstring[]NoMultiple logo URL sources

​
Errors

StatusDetailCause
400prompt_type must be 'active' or 'suggested'Invalid prompt_type query parameter