Competitors

The brands you track alongside your own. The competitor ids returned here are the actor_id values the metrics endpoints report against.

GET`/dimensions/competitors`

Lists competitors for the project.

GET`/dimensions/competitors/:id`

Get detailed information about a competitor including matching names and app store IDs.

POST`/competitors`

Add a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap.

Body (JSON):

project_idrequired
brand_namerequired
domainrequired, URL is normalised
matching_namesoptional array
citation_match_modedomain, host or path_prefix; default domain
citation_match_pathrequired for path_prefix

PATCH/DELETE /competitors/:id

Update a competitor (brand_name, website domain or host, matching_names, color, citation URL matching) or delete it. Name, website and citation-rule changes re-run historical matching in the background (processing: true for a few minutes, edits blocked meanwhile). Deleting is irreversible and purges the competitor data in the background.

PATCH body:

project_idrequired
brand_name
domainwebsite domain or host; a full URL is normalised
matching_namesfull replacement array
colorhex
citation_match_mode
citation_match_path

DELETE: project_id + :id in URL.

Code Examples

Download: OpenAPI Swagger Postman

Ask AI: Open in ChatGPT Open in Claude View as Markdown

Language

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/dimensions/competitors?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":1, "competitors":[ { "id":5,"name":"Contoso","domain":"contoso.com" } ], "request_id":"..." }

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/competitors/123"

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/competitors/123",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/competitors/123", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/dimensions/competitors/123', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/dimensions/competitors/123"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "id": 42, "project_id": 107, "brand_name": "Competitor X",
  "domain": "competitor-x.com", "matching_names": ["Competitor X", "CompX"],
  "google_play_id": "com.competitorx.app", "app_store_id": "123456789",
  "request_id": "..."
}

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]}' \
  "https://api.llmpulse.ai/api/v1/competitors"

const response = await fetch("https://api.llmpulse.ai/api/v1/competitors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/competitors",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/competitors",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/competitors", strings.NewReader(`{"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/competitors', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","brand_name":"Acme","domain":"acme.com","matching_names":["Acme","Acme Inc"]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/competitors"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"brand_name\":\"Acme\",\"domain\":\"acme.com\",\"matching_names\":[\"Acme\",\"Acme Inc\"]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());