public-api

Get Competitor Data

Get competitor analysis data. Use the view parameter to select different data views.

Every view honours days and tag_ids, so a view can be scoped to one business line and one window in a single call.

Views:

  • summary (default): Performance summary and head-to-head comparisons
  • arena: All prompts ranked as battlegrounds
  • head-to-head: Direct 1v1 comparison (requires competitor param)
  • by-model: Competitor breakdown per AI model
  • threats: Emerging competitor threats and opportunities
  • heatmap: Competitor presence matrix across models
  • over_time: Daily visibility per brand, you and your competitors
get/get-competitor-data

Request

  • Base URL: https://api.trakkr.ai
  • URL: https://api.trakkr.ai/get-competitor-data
  • Auth: HTTP bearer

Query parameters

brand_idstring uuid nullable

Brand UUID

brandstring uuid nullable

Alias for brand_id

viewstring nullable

View mode: summary (default), arena, head-to-head, by-model, threats, heatmap, over_time

competitorstring nullable

Competitor name. Required when view=head-to-head; on view=over_time it returns just you and that competitor.

daysinteger

History window every view is computed over. One of 7, 14, 30, 90.

tag_idsstring nullable

Comma-separated prompt tag UUIDs. Every metric in the response is recalculated over only the prompts carrying those tags, exactly as the Competitors page does when you filter by tag.

limitinteger

view=over_time only: how many competitor series to return, ranked best first.

periodstring nullable

A frozen calendar period instead of a rolling window: a month as YYYY-MM (2026-08) or a quarter as YYYY-Qn (2026-Q3). A closed month is read from the archive frozen when it closed; the open month is computed to date. When period is given, days is ignored and the response carries a period block saying exactly what was resolved. Definitions: /get-metrics.

Response

Successful Response

OR
OR
OR
OR
OR
OR
OR

Changes

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