Compras e anúncios

Superfícies comerciais dentro das respostas de IA: os cartões de produto que os modelos devolvem, as colocações pagas que aparecem ao lado e os negócios locais que os modelos listam para prompts com intenção local. Shopping e anúncios requerem o plano Scale ou superior; os negócios locais estão disponíveis em todos os planos. Os endpoints têm o nome daquilo que medem e não do assistente que os devolveu pela primeira vez, por isso restrinja com model em vez de deduzir o fornecedor a partir do caminho.

GET`/dimensions/shopping`

Cartões de produto apresentados nas respostas de IA. view=products (predefinido) devolve uma linha por produto distinto, agregado entre execuções, com o número de aparições, o intervalo de preços, a avaliação e se é seu. view=merchants devolve uma linha por comerciante que o vende. Um produto é identificado pelo seu id externo de produto, recorrendo ao título quando o fornecedor não envia um id utilizável, para que o mesmo produto seja agregado entre execuções em vez de se dividir numa linha por resposta.

Parâmetros:

project_idobrigatório
viewproducts|merchants
owned
query
orderproducts: appearances, price, rating, title; merchants: appearances, products, avg_price, avg_rating, merchant
direction
model
collection_id
country_code
language_code
prompt
prompt_type
brand_kind
range
from
to
page
per_page
output

Todas as respostas incluem também um bloco totals correspondente aos cartões de KPI na aplicação.

GET`/dimensions/ads`

Colocações pagas apresentadas nas respostas de IA. view=advertisers (predefinido) devolve uma linha por domínio de publicidade com o número de colocações, o alcance nos prompts e a posição média e melhor posição. view=ads devolve as colocações individuais com título, excerto, posição e o prompt que as desencadeou. A posição 1 é a melhor, pelo que uma posição média mais baixa é melhor.

Parâmetros:

project_idobrigatório
viewadvertisers|ads
owned
query
orderadvertisers: ads, prompts, avg_position, domain; ads: recent, oldest, position
directionapenas para advertisers; avg_position e domain têm ordem ascendente por predefinição
model
collection_id
country_code
language_code
prompt
prompt_type
brand_kind
range
from
to
page
per_page
output

GET`/dimensions/local_businesses`

Negócios locais (lojas, restaurantes, serviços) listados nas respostas de IA, uma linha por negócio. Cada negócio é definido pelo nome e pela morada, pelo que duas localizações de uma cadeia correspondem a duas linhas. Cada linha inclui o número de aparições, o número de prompts que o listaram, a classificação média e a posição média na lista, o número de avaliações e se é seu ou de um concorrente monitorizado. Disponível em todos os planos.

Parâmetros:

project_idobrigatório
owned
querynome ou morada
orderappearances, business, rating, reviews, avg_position, prompts
direction
model
collection_id
country_code
language_code
prompt
prompt_type
brand_kind
range
from
to
page
per_page
output

Todas as respostas incluem também um bloco totals correspondente aos cartões de KPI na aplicação.

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/shopping?project_id=PROJECT_ID&view=products&range=30"

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

import requests

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

require 'httparty'

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

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

Request

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

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

import requests

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

require 'httparty'

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

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

Request

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

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

import requests

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

require 'httparty'

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

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

Compras e anúncios

GET/dimensions/shopping

GET/dimensions/ads

GET/dimensions/local_businesses

GET`/dimensions/shopping`

GET`/dimensions/ads`

GET`/dimensions/local_businesses`