Menções e citações

Os registos em bruto por trás das métricas de visibilidade: uma linha por menção de marca ou por URL citado. Consulte-os para a sua marca, para concorrentes, ou para ambos num único fluxo.

GET`/dimensions/mentions`

Lista as menções criadas pelo seu projeto.

Parâmetros:

project_idobrigatório
collection_id
promptID do prompt
from
to
page
per_page

GET`/dimensions/citations`

Lista as citações criadas pelo seu projeto.

Parâmetros:

project_idobrigatório
collection_id
promptID do prompt
from
to
page
per_page

GET`/dimensions/competitor_mentions`

Lista as menções de concorrentes detetadas nas suas execuções.

Parâmetros:

project_idobrigatório
competitorsIDs em CSV
promptID do prompt
from
to
page
per_page

GET`/dimensions/competitor_citations`

Lista as citações de concorrentes detetadas nas suas execuções.

Parâmetros:

project_idobrigatório
competitorsIDs em CSV
promptID do prompt
from
to
page
per_page

GET`/dimensions/all_mentions`

Endpoint unificado que combina menções da marca e dos concorrentes. Cada registo inclui um campo actor_type (project ou competitor).

Parâmetros:

project_idobrigatório
competitorsIDs em CSV
model
collection_id
promptID do prompt
country_code
language_code
from
to
page
per_page

GET`/dimensions/all_citations`

Endpoint unificado que combina citações da marca e dos concorrentes. Cada registo inclui um campo actor_type (project ou competitor).

Parâmetros:

project_idobrigatório
competitorsIDs em CSV
model
collection_id
promptID do prompt
country_code
language_code
from
to
page
per_page

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/mentions?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/mentions?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/mentions?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/mentions?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/mentions?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/mentions?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":380,
  "data":[ { "id":7001, "name":"Acme", "prompt_id":101, "prompt_execution_id":9001, "created_at":"2025-03-01T10:00:02Z" } ],
  "request_id":"..." }

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/citations?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/citations?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/citations?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/citations?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/citations?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/citations?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":210,
  "data":[ { "id":8001, "name":"Acme", "domain":"acme.com", "prompt_id":101, "prompt_execution_id":9001, "url":"https://acme.com/article", "position":2, "created_at":"2025-03-01T10:00:03Z" } ],
  "request_id":"..." }

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/competitor_mentions?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/competitor_mentions?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/competitor_mentions?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/competitor_mentions?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/competitor_mentions?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/competitor_mentions?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":95,
  "data":[ { "id":9101, "competitor_id":19, "name":"Contoso", "domain":"contoso.com", "prompt_execution_id":9001, "created_at":"2025-03-01T10:01:00Z" } ],
  "request_id":"..." }

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/competitor_citations?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/competitor_citations?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/competitor_citations?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/competitor_citations?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/competitor_citations?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/competitor_citations?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":31,
  "data":[ { "id":9201, "competitor_id":20, "name":"Contoso", "domain":"contoso.com", "prompt_execution_id":9001, "url":"https://contoso.com/page", "position":1, "created_at":"2025-03-01T10:01:30Z" } ],
  "request_id":"..." }

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/all_mentions?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/all_mentions?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/all_mentions?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/all_mentions?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/all_mentions?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/all_mentions?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":475,
  "data":[
    { "id":7001, "actor_type":"project", "name":"Acme", "prompt_id":101, "prompt_execution_id":9001, "created_at":"2025-03-01T10:00:02Z" },
    { "id":9101, "actor_type":"competitor", "competitor_id":19, "name":"Contoso", "domain":"contoso.com", "prompt_id":101, "prompt_execution_id":9001, "created_at":"2025-03-01T10:01:00Z" }
  ],
  "request_id":"..." }

Request

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

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/all_citations?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/all_citations?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/all_citations?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/all_citations?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/all_citations?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/all_citations?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "page":1, "per_page":20, "total":241,
  "data":[
    { "id":8001, "actor_type":"project", "name":"Acme", "domain":"acme.com", "prompt_id":101, "prompt_execution_id":9001, "url":"https://acme.com/article", "position":2, "created_at":"2025-03-01T10:00:03Z" },
    { "id":9201, "actor_type":"competitor", "competitor_id":20, "name":"Contoso", "domain":"contoso.com", "prompt_id":101, "prompt_execution_id":9001, "url":"https://contoso.com/page", "position":1, "created_at":"2025-03-01T10:01:30Z" }
  ],
  "request_id":"..." }

Menções e citações

GET/dimensions/mentions

GET/dimensions/citations

GET/dimensions/competitor_mentions

GET/dimensions/competitor_citations

GET/dimensions/all_mentions

GET/dimensions/all_citations

GET`/dimensions/mentions`

GET`/dimensions/citations`

GET`/dimensions/competitor_mentions`

GET`/dimensions/competitor_citations`

GET`/dimensions/all_mentions`

GET`/dimensions/all_citations`