Get competitor data

curl --request GET \
  --url https://api.trakkr.ai/get-competitor-data \
  --header 'Authorization: Bearer <token>'

{
  "brand_performance_summary": [
    {
      "brand_name": "Acme Corporation",
      "total_mentions_overall": 150,
      "overall_avg_score": 85.5,
      "overall_avg_rank": "2.3",
      "overall_rank_distribution": [
        {
          "bucket": "Rank 1",
          "percentage": 25.5,
          "count": 45
        },
        {
          "bucket": "Ranks 2-3",
          "percentage": 35.2,
          "count": 62
        }
      ],
      "llm_specific_performance_list": [
        {
          "llm_name": "OpenAI",
          "total_mentions": 75,
          "avg_score": 88.2,
          "avg_rank": "1.8",
          "rank_distribution": [
            {
              "bucket": "Rank 1",
              "percentage": 30,
              "count": 25
            }
          ]
        }
      ]
    },
    {
      "brand_name": "Competitor A",
      "total_mentions_overall": 120,
      "overall_avg_score": 78.3,
      "overall_avg_rank": "3.1",
      "overall_rank_distribution": [
        {
          "bucket": "Rank 1",
          "percentage": 15,
          "count": 18
        }
      ],
      "llm_specific_performance_list": [
        {
          "llm_name": "OpenAI",
          "total_mentions": 60,
          "avg_score": 82.1,
          "avg_rank": "2.5"
        }
      ]
    }
  ],
  "daily_visibility_data": [
    {
      "date": "2025-01-15",
      "prompts_data": [
        {
          "prompt_text": "What are the best CRM platforms?",
          "llm_breakdown": [
            {
              "llm_name": "OpenAI",
              "visibility_scores": [
                {
                  "brand_name": "Acme Corporation",
                  "avg_score": 88.5,
                  "avg_rank": "1.8",
                  "mention_count": 15,
                  "date": "2025-01-15"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "top_spot_ownership": [
    {
      "prompt_text": "What are the best CRM platforms?",
      "top_brand": "Acme Corporation",
      "count_of_rank_1_for_top_brand": 25,
      "all_rank_1_counts_list": [
        {
          "brand_name": "Acme Corporation",
          "count": 25
        },
        {
          "brand_name": "Competitor A",
          "count": 18
        }
      ]
    }
  ],
  "primary_brand_cooccurrences": [
    {
      "competitor_name": "Competitor A",
      "cooccurrence_count": 45,
      "cooccurrence_rate_percent": 75.5,
      "primary_brand_position_above_rate_percent": 60
    }
  ],
  "opportunity_prompts": [
    {
      "prompt_text": "What are the best email marketing tools?",
      "primary_brand_rank_info": "Not Ranked",
      "highly_ranked_competitors": [
        "Mailchimp",
        "Constant Contact"
      ]
    }
  ],
  "llm_performance_overview": [
    {
      "llm_name": "OpenAI",
      "primary_brand_metrics": {
        "brand_name": "Acme Corporation",
        "avg_rank": "1.8",
        "avg_score": 88.2,
        "total_mentions": 75
      },
      "competitor_metrics": [
        {
          "brand_name": "Competitor A",
          "avg_rank": "2.5",
          "avg_score": 82.1,
          "total_mentions": 60
        }
      ]
    }
  ]
}

GET

get-competitor-data

Get competitor data

curl --request GET \
  --url https://api.trakkr.ai/get-competitor-data \
  --header 'Authorization: Bearer <token>'

{
  "brand_performance_summary": [
    {
      "brand_name": "Acme Corporation",
      "total_mentions_overall": 150,
      "overall_avg_score": 85.5,
      "overall_avg_rank": "2.3",
      "overall_rank_distribution": [
        {
          "bucket": "Rank 1",
          "percentage": 25.5,
          "count": 45
        },
        {
          "bucket": "Ranks 2-3",
          "percentage": 35.2,
          "count": 62
        }
      ],
      "llm_specific_performance_list": [
        {
          "llm_name": "OpenAI",
          "total_mentions": 75,
          "avg_score": 88.2,
          "avg_rank": "1.8",
          "rank_distribution": [
            {
              "bucket": "Rank 1",
              "percentage": 30,
              "count": 25
            }
          ]
        }
      ]
    },
    {
      "brand_name": "Competitor A",
      "total_mentions_overall": 120,
      "overall_avg_score": 78.3,
      "overall_avg_rank": "3.1",
      "overall_rank_distribution": [
        {
          "bucket": "Rank 1",
          "percentage": 15,
          "count": 18
        }
      ],
      "llm_specific_performance_list": [
        {
          "llm_name": "OpenAI",
          "total_mentions": 60,
          "avg_score": 82.1,
          "avg_rank": "2.5"
        }
      ]
    }
  ],
  "daily_visibility_data": [
    {
      "date": "2025-01-15",
      "prompts_data": [
        {
          "prompt_text": "What are the best CRM platforms?",
          "llm_breakdown": [
            {
              "llm_name": "OpenAI",
              "visibility_scores": [
                {
                  "brand_name": "Acme Corporation",
                  "avg_score": 88.5,
                  "avg_rank": "1.8",
                  "mention_count": 15,
                  "date": "2025-01-15"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "top_spot_ownership": [
    {
      "prompt_text": "What are the best CRM platforms?",
      "top_brand": "Acme Corporation",
      "count_of_rank_1_for_top_brand": 25,
      "all_rank_1_counts_list": [
        {
          "brand_name": "Acme Corporation",
          "count": 25
        },
        {
          "brand_name": "Competitor A",
          "count": 18
        }
      ]
    }
  ],
  "primary_brand_cooccurrences": [
    {
      "competitor_name": "Competitor A",
      "cooccurrence_count": 45,
      "cooccurrence_rate_percent": 75.5,
      "primary_brand_position_above_rate_percent": 60
    }
  ],
  "opportunity_prompts": [
    {
      "prompt_text": "What are the best email marketing tools?",
      "primary_brand_rank_info": "Not Ranked",
      "highly_ranked_competitors": [
        "Mailchimp",
        "Constant Contact"
      ]
    }
  ],
  "llm_performance_overview": [
    {
      "llm_name": "OpenAI",
      "primary_brand_metrics": {
        "brand_name": "Acme Corporation",
        "avg_rank": "1.8",
        "avg_score": 88.2,
        "total_mentions": 75
      },
      "competitor_metrics": [
        {
          "brand_name": "Competitor A",
          "avg_rank": "2.5",
          "avg_score": 82.1,
          "total_mentions": 60
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Query Parameters

brand

string

required

The brand ID (32-character hexadecimal string)

Required string length: 32

Response

Successful response

brand_performance_summary

object[]

required

Summary of performance for all brands (primary + competitors)

Show child attributes

brand_performance_summary.brand_name

string

required

Name of the brand

Example:

"Acme Corporation"

brand_performance_summary.total_mentions_overall

integer

required

Total number of mentions across all data

Example:

150

brand_performance_summary.overall_avg_score

number<float>

required

Average visibility score across all data

Example:

85.5

brand_performance_summary.overall_avg_rank

string

required

Average rank across all data (empty string if no rankings)

Example:

"2.3"

brand_performance_summary.overall_rank_distribution

object[]

required

Distribution of rankings across different buckets

Show child attributes

brand_performance_summary.overall_rank_distribution.bucket

string

required

Rank bucket name

Example:

"Rank 1"

brand_performance_summary.overall_rank_distribution.percentage

number<float>

required

Percentage of appearances in this bucket

Example:

25.5

brand_performance_summary.overall_rank_distribution.count

integer

required

Number of appearances in this bucket

Example:

45

brand_performance_summary.llm_specific_performance_list

object[]

required

Performance breakdown by LLM

Show child attributes

brand_performance_summary.llm_specific_performance_list.llm_name

string

required

Name of the LLM

Example:

"OpenAI"

brand_performance_summary.llm_specific_performance_list.total_mentions

integer

required

Total mentions for this LLM

Example:

75

brand_performance_summary.llm_specific_performance_list.avg_score

number<float>

required

Average visibility score for this LLM

Example:

88.2

brand_performance_summary.llm_specific_performance_list.avg_rank

string

required

Average rank for this LLM (empty string if no rankings)

Example:

"1.8"

brand_performance_summary.llm_specific_performance_list.rank_distribution

object[]

required

Rank distribution for this LLM

Show child attributes

brand_performance_summary.llm_specific_performance_list.rank_distribution.bucket

string

required

Rank bucket name

Example:

"Rank 1"

brand_performance_summary.llm_specific_performance_list.rank_distribution.percentage

number<float>

required

Percentage of appearances in this bucket

Example:

25.5

brand_performance_summary.llm_specific_performance_list.rank_distribution.count

integer

required

Number of appearances in this bucket

Example:

45

daily_visibility_data

object[]

required

Daily visibility data organized by date and prompt

Show child attributes

daily_visibility_data.date

string<date>

required

The date for this data

Example:

"2025-01-15"

daily_visibility_data.prompts_data

object[]

required

Data organized by prompt

Show child attributes

daily_visibility_data.prompts_data.prompt_text

string

required

The prompt text

Example:

"What are the best CRM platforms?"

daily_visibility_data.prompts_data.llm_breakdown

object[]

required

Data broken down by LLM

Show child attributes

daily_visibility_data.prompts_data.llm_breakdown.llm_name

string

required

Name of the LLM

Example:

"OpenAI"

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores

object[]

required

Visibility scores for each brand

Show child attributes

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores.brand_name

string

required

Name of the brand

Example:

"Acme Corporation"

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores.avg_score

number<float>

required

Average visibility score

Example:

85.5

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores.avg_rank

string

required

Average rank (empty string if no rankings)

Example:

"2.3"

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores.mention_count

integer

required

Number of mentions

Example:

15

daily_visibility_data.prompts_data.llm_breakdown.visibility_scores.date

string<date>

required

The date

Example:

"2025-01-15"

top_spot_ownership

object[]

required

Analysis of which brands own the top spot for each prompt

Show child attributes

top_spot_ownership.prompt_text

string

required

The prompt text

Example:

"What are the best CRM platforms?"

top_spot_ownership.top_brand

string

required

Brand that owns the top spot most often

Example:

"Salesforce"

top_spot_ownership.count_of_rank_1_for_top_brand

integer

required

Number of times the top brand ranked

Example:

25

top_spot_ownership.all_rank_1_counts_list

object[]

required

Count of rank 1 appearances for all brands

Show child attributes

top_spot_ownership.all_rank_1_counts_list.brand_name

string

required

Name of the brand

Example:

"Salesforce"

top_spot_ownership.all_rank_1_counts_list.count

integer

required

Number of rank 1 appearances

Example:

25

primary_brand_cooccurrences

object[]

required

Co-occurrence analysis between primary brand and competitors

Show child attributes

primary_brand_cooccurrences.competitor_name

string

required

Name of the competitor

Example:

"HubSpot"

primary_brand_cooccurrences.cooccurrence_count

integer

required

Number of times both brands appeared together

Example:

45

primary_brand_cooccurrences.cooccurrence_rate_percent

number<float>

required

Percentage of primary brand appearances where competitor also appeared

Example:

75.5

primary_brand_cooccurrences.primary_brand_position_above_rate_percent

number<float>

required

Percentage of co-occurrences where primary brand ranked higher

Example:

60

opportunity_prompts

object[]

required

Prompts where competitors rank highly but primary brand doesn't

Show child attributes

opportunity_prompts.prompt_text

string

required

The prompt text

Example:

"What are the best CRM platforms?"

opportunity_prompts.primary_brand_rank_info

string

required

Primary brand's rank or "Not Ranked"

Example:

"Not Ranked"

opportunity_prompts.highly_ranked_competitors

string[]

required

List of competitors that ranked in top 3

Example:

["Salesforce", "HubSpot"]

llm_performance_overview

object[]

required

Performance comparison across different LLMs

Show child attributes

llm_performance_overview.llm_name

string

required

Name of the LLM

Example:

"OpenAI"

llm_performance_overview.primary_brand_metrics

object

required

Show child attributes

llm_performance_overview.primary_brand_metrics.brand_name

string

required

Name of the brand

Example:

"Acme Corporation"

llm_performance_overview.primary_brand_metrics.avg_rank

string

required

Average rank (empty string if no rankings)

Example:

"2.3"

llm_performance_overview.primary_brand_metrics.avg_score

number<float>

required

Average visibility score

Example:

85.5

llm_performance_overview.primary_brand_metrics.total_mentions

integer

required

Total number of mentions

Example:

150

llm_performance_overview.competitor_metrics

object[]

required

Metrics for all competitors

Show child attributes

llm_performance_overview.competitor_metrics.brand_name

string

required

Name of the brand

Example:

"Acme Corporation"

llm_performance_overview.competitor_metrics.avg_rank

string

required

Average rank (empty string if no rankings)

Example:

"2.3"

llm_performance_overview.competitor_metrics.avg_score

number<float>

required

Average visibility score

Example:

85.5

llm_performance_overview.competitor_metrics.total_mentions

integer

required

Total number of mentions

Example:

150

Get brands Get citations

⌘I

Getting Started

API Endpoints

Get competitor data

Authorizations

Query Parameters

Response