Skip to main content
GET
/
ai-analytics-service
/
api
/
public
/
v1
/
analytics
/
metrics
Get Metrics
curl --request GET \
  --url https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/metrics \
  --header 'Authorization: <authorization>'
{
  "metrics": [
    {
      "brandMentions": 123,
      "position": 123,
      "visibility": 123,
      "entityName": "<string>",
      "entityType": "<string>",
      "shareOfVoice": 123,
      "date": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://slatehq.com/docs/llms.txt

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

Returns aggregated performance metrics for your brand over a specified date range. Includes mention counts, average position, visibility score, and share of voice.

Parameters

Authorization
string
required
Bearer token. Format: Bearer slat_<your-token>.
dateRange
integer
required
Number of days for the metrics window (e.g., 7, 30, 90).
topicId
number
Filter by topic ID.
platform
string[]
Filter by one or more platforms: CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.
runId
number
Filter by a specific query run ID.

Response

Returns 200 OK with an array of performance metric objects.
metrics
object[]
required
Array of metric data points.

Example

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

Response

[
  {
    "brandMentions": 42,
    "position": 2,
    "visibility": 85,
    "entityName": "MyBrand",
    "entityType": "BRAND",
    "shareOfVoice": 35.5,
    "date": "2026-02-11"
  }
]

Status codes

StatusDescription
200Metrics returned.
401Missing or invalid Bearer token. See Authentication.
500Internal server error.

What’s next