Métricas

Datos agregados de visibilidad, Share of Voice, citaciones y posiciones de tu marca y sus competidores, listos para representar en gráficos. Todos los endpoints aceptan los filtros comunes y el parámetro output descrito en Conceptos básicos.

GET`/metrics/timeseries`

Devuelve series temporales de una o más métricas, agrupadas por actor (tu proyecto + los competidores seleccionados). Los valores semanales y mensuales siguen la semántica de períodos descrita más arriba. Los filtros opcionales prompt_type (intención de búsqueda) y brand_kind acotan cada métrica a una categoría de prompt.

GET`/metrics/summary`

Agrega por actor y métrica (total/min/max/last). Ideal para tarjetas KPI.

GET`/metrics/prompt_summary`

Devuelve métricas agregadas por prompt y paginadas (responses, mentions, citations, mention_rate, citation_rate, avg_mention_position, avg_position). Admite breakdown=model para añadir la dimensión de modelo de IA a cada fila, devolviendo métricas por prompt y por modelo. Parámetros: sort (responses, mentions, citations, mention_rate o visibility, citation_rate, avg_mention_position, avg_position), sort_dir (asc/desc), breakdown (model), page, per_page (máx. 100).

GET`/metrics/sov`

Share of Voice basado en menciones, alineado con el resumen.

over_time: para cada fecha, SOV = (actor_mentions / sum_all_mentions) × 100. Si la suma diaria es 0, se arrastra el último valor (sticky).
current: usa la fecha más reciente con total distinto de cero; si no hay ninguna, usa los totales de todo el rango.
breakdown: los 4 principales actores + una fila agregada Others (y una lista detallada others).
periods y sample: cada período incluye el total de mentions sobre el que se calcularon sus cuotas, un indicador partial, un nivel confidence (none sin menciones, low por debajo de 30, medium por debajo de 100, high a partir de 100) y margin_of_error, el margen de error al 95% en el peor de los casos, expresado en puntos porcentuales (98 dividido entre la raíz cuadrada de mentions, lo que da unos 18 puntos con 30 menciones y unos 10 con 100; null sin menciones). sample repite el período sobre el que se calcularon las cuotas de current, o es null cuando no hay menciones en la ventana.

GET`/metrics/top_sources`

Ordena los dominios de fuentes por número de respuestas y tasa media de mención (% de ejecuciones en las que apareció ese dominio).

El conjunto de datos incluye fuentes no rechazadas vinculadas a ejecuciones de prompts dentro del período y los filtros actuales.
total_responses: número de ejecuciones de prompt únicas que produjeron al menos una fuente en ese dominio.
avg_mention_rate (también se devuelve como avg_visibility): (número de filas de fuentes del dominio / total de ejecuciones) × 100.
Ordenación: sort=total_responses (por defecto), sort=avg_mention_rate o sort=avg_visibility.
Paginación: page (>=1), per_page (por defecto 20, máximo 100).
Filtra por dominio: query (LIKE sin distinguir mayúsculas), p. ej. query=github.

Ejemplos de código

Download: OpenAPI Swagger Postman

Preguntar a la IA: Abrir en ChatGPT Abrir en Claude Ver como Markdown

Idioma

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"

const response = await fetch("https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", 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/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30', [
    '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/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "project_id":"...",
  "from":"2025-02-01T00:00:00Z",
  "to":"2025-03-02T23:59:59Z",
  "granularity":"day",
  "filters":{ ... },
  "series":{
    "mentions":[
      { "actor": { "type":"project","id":1,"name":"Acme","domain":null }, "metric":"mentions",
        "data":[ { "date":"2025-02-01","value":12 }, ... ] },
      { "actor": { "type":"competitor","id":5,"name":"Contoso","domain":"contoso.com" }, "metric":"mentions", "data":[ ... ] }
    ],
    "visibility":[ ... ],
    "citations":[ ... ],
    "avg_position":[ ... ]
  },
  "request_id":"..."
}

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30"

const response = await fetch("https://api.llmpulse.ai/api/v1/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30", 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/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30', [
    '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/metrics/summary?project_id=PROJECT_ID&metrics=mentions,citations&granularity=day&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "series": { ... },
  "summary": {
    "mentions": [
      { "actor": { "type":"project","id":1,"name":"Acme" }, "total":1450, "min":0, "max":120, "last":34 }
    ],
    "avg_position": [
      { "actor": { "type":"project","id":1,"name":"Acme" }, "total":3.42, "min":2.1, "max":5.3, "last":3.8 }
    ]
  }
}

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50"

const response = await fetch("https://api.llmpulse.ai/api/v1/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50", 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/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50', [
    '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/metrics/prompt_summary?project_id=PROJECT_ID&range=30&sort=visibility&sort_dir=desc&per_page=50"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "project_id": 1,
  "breakdown": "model",
  "sort": "mention_rate", "sort_dir": "desc",
  "page": 1, "per_page": 50, "total": 230,
  "data": [
    {
      "prompt_id": 123,
      "prompt_text": "best CRM software",
      "model": "chatgpt",
      "responses": 50,
      "mentions": 30,
      "citations": 15,
      "visibility": 60.0,
      "mention_rate": 60.0,
      "citation_rate": 30.0,
      "avg_mention_position": 2.35,
      "avg_position": 3.1
    }
  ]
}

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/sov?project_id=PROJECT_ID&range=30"

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

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/sov?project_id=PROJECT_ID&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

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

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/sov?project_id=PROJECT_ID&range=30", 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/metrics/sov?project_id=PROJECT_ID&range=30', [
    '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/metrics/sov?project_id=PROJECT_ID&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "over_time":[
    { "actor": { "type":"project","id":1,"name":"Acme" },
      "data":[ { "date":"2025-02-01","value":42.8 }, ... ] }
  ],
  "current":[
    { "actor": { "type":"project","id":1,"name":"Acme" }, "share":48.12 },
    { "actor": { "type":"competitor","id":5,"name":"Contoso" }, "share":33.27 },
    { "actor": { "type":"competitor","id":7,"name":"Fabrikam" }, "share":18.61 }
  ],
  "breakdown": [
    { "rank":1, "actor": { "type":"project","id":1,"name":"Acme" }, "share":48.12 },
    { "rank":2, "actor": { "type":"competitor","id":5,"name":"Contoso" }, "share":33.27 },
    { "rank":3, "actor": { "type":"competitor","id":7,"name":"Fabrikam" }, "share":18.61 },
    { "rank":5, "actor": { "name":"Others" }, "share":12.00, "others":true }
  ],
  "others": [
    { "rank":5, "actor": { "type":"competitor","id":9,"name":"Globex" }, "share":7.00 }
  ]
}

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/top_sources?project_id=PROJECT_ID&range=30"

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

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/top_sources?project_id=PROJECT_ID&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

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

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/top_sources?project_id=PROJECT_ID&range=30", 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/metrics/top_sources?project_id=PROJECT_ID&range=30', [
    '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/metrics/top_sources?project_id=PROJECT_ID&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "project_id":"...",
  "from":"2025-02-01T00:00:00Z",
  "to":"2025-03-02T23:59:59Z",
  "filters":{ ... },
  "sort":"avg_mention_rate",
  "page":1,
  "per_page":20,
  "total":57,
  "data":[
    { "domain":"example.com", "total_responses":42, "avg_visibility":18.75, "avg_mention_rate":18.75 },
    { "domain":"another.com", "total_responses":37, "avg_visibility":15.10, "avg_mention_rate":15.10 }
  ],
  "request_id":"..."
}

Métricas

GET/metrics/timeseries

GET/metrics/summary

GET/metrics/prompt_summary

GET/metrics/sov

GET/metrics/top_sources

GET`/metrics/timeseries`

GET`/metrics/summary`

GET`/metrics/prompt_summary`

GET`/metrics/sov`

GET`/metrics/top_sources`