---
title: "Platform analytics"
method: GET
path: "/api/v1/analytics/platforms"
tags: ["analytics"]
---

# Platform analytics

`GET /api/v1/analytics/platforms`

## Request

- Base URL: `https://pineprompt.com`
- URL: `https://pineprompt.com/api/v1/analytics/platforms`
- Auth: HTTP bearer

Returns per-platform aggregates across the filter window, scoped to a single brand. Every platform present in the filtered response set is returned; the result is not paginated.

## Query parameters

- `start_date` string, date, required
- `end_date` string, date, required
- `brand_id` integer, required
- `platforms` string[]
- `countries` string[]
- `monitors` integer[]
- `segments` integer[]
- `tags` integer[]

## Headers

- `Pineprompt-Project-Id` integer, required

## Response `200`

OK

- PlatformAnalytics[]
  - `platform` string: The AI platform this row covers.
  - `visibility` integer: The percentage of analyzed responses on this platform that mention the brand.
  - `visibility_change` integer: The difference in visibility compared with the equal-length period immediately preceding the window.
  - `share_of_voice` integer: This brand's share of the mentions of the brands in the filter scope on this platform. A segment filter narrows the scope to the segment's brands.
  - `share_of_voice_change` integer: The difference in share of voice compared with the preceding period.
  - `sentiment` integer, nullable: The average sentiment score on a 0-100 scale. `null` when the brand had no mentions on this platform.
  - `sentiment_change` integer, nullable: The difference in sentiment compared with the preceding period. `null` when either period lacks data.
  - `position` number, float, nullable: The average position of the brand within the responses on this platform that mention it. A lower value is better. `null` when the brand had no mentions on this platform.
  - `position_change` number, float, nullable: The difference in position compared with the preceding period. A negative value indicates an improvement. `null` when either period lacks data.
  - `used_count` integer: The number of analyzed responses on this platform inside the window.
  - `used_count_change` integer: The difference in `used_count` compared with the preceding period.

## Other responses

- `400`: Missing project header
- `401`: Unauthorized
- `403`: Missing ability
- `404`: Project not in this organization
- `422`: Validation failed

---

[API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)