analytics

Platform analytics

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.

get/api/v1/analytics/platforms

Request

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

Query parameters

start_datestring date required
Example:2026-04-01

The inclusive UTC start of the analytics window, given as an ISO 8601 date (YYYY-MM-DD).

end_datestring date required
Example:2026-05-20

The inclusive UTC end of the analytics window. The value must be on or after start_date, and on or before today.

brand_idinteger required
Example:555

The numeric ID of the brand to scope per-row metrics to. The brand must belong to the active project.

platformsstring[]

You may use this parameter to limit responses to one or more AI platforms. Repeat the parameter for each value, for example ?platforms[]=chatgpt&platforms[]=claude. When omitted, every platform is included. Accepted values: chatgpt, perplexity, gemini, grok, copilot, claude, google_ai_mode, and google_ai_overview.

countriesstring[]

You may use this parameter to limit responses to monitors run in the given ISO-3166-1 alpha-2 country codes.

[
  "US",
  "NL"
]
monitorsinteger[]

You may use this parameter to limit responses to specific monitors inside the active project.

[
  271,
  272
]
segmentsinteger[]

You may use this parameter to limit responses and brand-scoped metrics to brands attached to any of the given segments. Segments are named groupings of brands, such as Direct Competitors. When this parameter is set, time-series charts show every brand in the selected segments instead of capping the series at top_n, and share-of-voice ratios are computed within the segment, so each brand's share reads against the other brands in the selected segments. Source-keyed endpoints do not honor this parameter.

[
  12
]
tagsinteger[]

You may use this parameter to limit responses to those whose prompt carries any of the given tag IDs, such as branded or non-branded.

[
  3,
  5
]

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

platformstring

The AI platform this row covers.

visibilityinteger

The percentage of analyzed responses on this platform that mention the brand.

visibility_changeinteger

The difference in visibility compared with the equal-length period immediately preceding the window.

share_of_voiceinteger

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_changeinteger

The difference in share of voice compared with the preceding period.

sentimentinteger nullable

The average sentiment score on a 0-100 scale. null when the brand had no mentions on this platform.

sentiment_changeinteger nullable

The difference in sentiment compared with the preceding period. null when either period lacks data.

positionnumber 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_changenumber float nullable

The difference in position compared with the preceding period. A negative value indicates an improvement. null when either period lacks data.

used_countinteger

The number of analyzed responses on this platform inside the window.

used_count_changeinteger

The difference in used_count compared with the preceding period.

Example response

[
  {
    "platform": "chatgpt",
    "visibility": 73,
    "visibility_change": 5,
    "share_of_voice": 28,
    "share_of_voice_change": -2,
    "sentiment": 67,
    "sentiment_change": 1,
    "position": 1.4,
    "position_change": -0.2,
    "used_count": 42,
    "used_count_change": 4
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.