Get Overview Summary

Retrieve key performance indicators, entity breakdown, and platform stats for your brand.

GET /ai-analytics-service/api/public/v1/analytics/overview/summary

Get Overview Summary

cURL

curl --request GET \
  --url https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary \
  --header 'Authorization: <authorization>'

200

{
  "brand": {
    "id": 123,
    "name": "<string>"
  },
  "kpis": {
    "mentions": {
      "mentions": 123,
      "runsWithBrand": 123,
      "totalRuns": 123,
      "mentionRatePct": 123,
      "delta": 123
    },
    "avgPosition": {
      "value": 123,
      "delta": 123
    },
    "visibilityPct": {
      "value": 123,
      "delta": 123
    },
    "shareOfVoicePct": {
      "value": 123,
      "delta": 123
    }
  },
  "entities": [
    {
      "name": "<string>",
      "type": "<string>",
      "mentions": 123,
      "avgPosition": 123,
      "visibilityPct": 123,
      "shareOfVoicePct": 123
    }
  ],
  "platforms": [
    {
      "platform": "<string>",
      "runs": 123,
      "mentions": 123,
      "visibilityPct": 123
    }
  ]
}

Returns a compact overview of your brand’s AI search performance. Includes KPIs (mentions, average position, visibility, share of voice), a ranked list of entities (brand + competitors), and per-platform stats. All metrics include period-over-period deltas.

Parameters

Authorization · string · required

Bearer token. Format: Bearer slat_<your-token>.

dateRange · integer

Number of days for the analysis window (e.g., 7, 30, 90).

from · string

Start of date range. ISO 8601 format (e.g., 2026-02-01T00:00:00Z).

to · string

End of date range. ISO 8601 format.

brandId · number

Brand ID. Optional — if omitted, uses the workspace’s default brand.

topicId · number

Filter by topic ID.

platforms · string[]

Filter by one or more platforms: CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.

region · string

Filter by ISO country code for region.

promptId · number

Filter by a single prompt ID.

promptIds · number[]

Filter by multiple prompt IDs. Maximum 10 values.

Response

Returns 200 OK with the overview summary.

brand · object · required

Brand reference.

Show brand object

id · number · required

Brand ID.

name · string · required

Brand name.

kpis · object · required

Key performance indicators with period-over-period comparison.

Show KPIs object

mentions · object · required

Mention metrics.

Show mentions metric

mentions · integer

Total brand mentions.

runsWithBrand · integer

Query runs that mentioned the brand.

totalRuns · integer

Total query runs in the period.

mentionRatePct · number

Percentage of runs that mentioned the brand.

delta · integer

Change in mentions compared to the previous period.

avgPosition · object · required

Average position in AI responses.

Show metric

value · number

Current value.

delta · number

Change from previous period.

visibilityPct · object · required

Visibility percentage.

Show metric

value · number

Current value.

delta · number

Change from previous period.

shareOfVoicePct · object · required

Share of voice percentage.

Show metric

value · number

Current value.

delta · number

Change from previous period.

entities · object[] · required

Ranked list of brands and competitors.

Show entity object

name · string · required

Entity name.

type · string · required

One of: BRAND, COMPETITOR, OTHER.

mentions · integer · required

Total mentions.

avgPosition · number

Average position.

visibilityPct · number

Visibility percentage.

shareOfVoicePct · number

Share of voice percentage.

platforms · object[] · required

Per-platform performance breakdown.

Show platform stat

platform · string · required

Platform name.

runs · integer · required

Total runs on the platform.

mentions · integer · required

Mentions on the platform.

visibilityPct · number · required

Visibility percentage on the platform.

Example

cURL

curl -s "https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary?dateRange=30&topicId=42" \
  -H "Authorization: Bearer slat_YOUR_TOKEN"

Response

{
  "brand": {
    "id": 5,
    "name": "MyBrand"
  },
  "kpis": {
    "mentions": {
      "mentions": 120,
      "runsWithBrand": 85,
      "totalRuns": 200,
      "mentionRatePct": 42.5,
      "delta": 15
    },
    "avgPosition": { "value": 2.3, "delta": -0.5 },
    "visibilityPct": { "value": 78.0, "delta": 3.2 },
    "shareOfVoicePct": { "value": 35.5, "delta": 2.1 }
  },
  "entities": [
    {
      "name": "MyBrand",
      "type": "BRAND",
      "mentions": 120,
      "avgPosition": 2.3,
      "visibilityPct": 78.0,
      "shareOfVoicePct": 35.5
    },
    {
      "name": "CompetitorA",
      "type": "COMPETITOR",
      "mentions": 90,
      "avgPosition": 3.1,
      "visibilityPct": 65.0,
      "shareOfVoicePct": 26.7
    }
  ],
  "platforms": [
    { "platform": "CHATGPT", "runs": 80, "mentions": 55, "visibilityPct": 82.0 },
    { "platform": "PERPLEXITY", "runs": 60, "mentions": 40, "visibilityPct": 75.0 },
    { "platform": "GEMINI", "runs": 60, "mentions": 25, "visibilityPct": 70.0 }
  ]
}

Status codes

Status	Description
200	Overview summary returned.
400	promptIds exceeds maximum of 10 values.
401	Missing or invalid Bearer token. See Authentication.
500	Internal server error.

What’s next

• Get Overview Trend — View time series trends.
• Get Citations Summary — View citation analytics.