Relatórios personalizados

Os relatórios personalizados criados na secção Relatórios personalizados da aplicação: liste-os, leia um deles com os dados de cada widget tal como a respetiva página os apresenta e envie-o de imediato por email aos respetivos destinatários. Plano Scale ou superior. Os endereços dos destinatários, o token do link partilhado e a palavra-passe nunca são devolvidos.

GET`/custom_reports`

Os relatórios personalizados do projeto, do mais recente para o mais antigo, com o intervalo de datas, o agendamento de envio, o número de destinatários, a indicação de se o link partilhado está publicado e os widgets que cada um apresenta. Também disponível como a ferramenta MCP list_custom_reports.

Parâmetros:

project_idobrigatório
page
per_pagepredefinição 20, máx. 100
output

GET`/custom_reports/:id`

A configuração de um relatório (intervalo de datas, filtros de modelo, etiqueta, tipo de marca e concorrentes, agendamento, disposição) e os dados de cada widget calculados no momento, os mesmos números que a respetiva página, o link partilhado e o PDF apresentam. Cada widget tem um kind e um objeto data cuja estrutura depende dele: series (timeseries), slices (donut), bars (bar), values e changes (kpi_grid) ou rows (table). Um widget cuja fonte de dados não está ligada tem available: false. Só de leitura. Também disponível como a ferramenta MCP get_custom_report.

Parâmetros:

project_idobrigatório
:idno URL

Devolve ERR_NOT_FOUND para um relatório fora do projeto.

POST`/custom_reports/:id/send`

Envia de imediato o relatório por email aos respetivos destinatários, tal como o botão Enviar agora na página do relatório: o relatório tem de estar publicado e ter pelo menos um destinatário (caso contrário, ERR_INVALID_PARAM), e cada relatório pode ser enviado uma vez a cada 10 minutos (429 ERR_RATE_LIMITED com Retry-After). Devolve 202 assim que o PDF é colocado em fila. Não disponível a partir de um portal de marca branca nem para um relatório criado num portal desse tipo (ERR_INTEGRATION_UNAVAILABLE). Requer uma chave de API com âmbito de escrita e, para os membros da equipa, a permissão de atualização em Relatórios personalizados. Também disponível como a ferramenta MCP send_custom_report.

Caminho:

:idid do relatório

Corpo (JSON): project_id (obrigatório).

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/custom_reports?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/custom_reports?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/custom_reports?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

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

package main

import "net/http"

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

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/custom_reports?project_id=PROJECT_ID"))
            .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/custom_reports/42?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/custom_reports/42?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/custom_reports/42?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

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

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/custom_reports/42?project_id=PROJECT_ID", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/custom_reports/42?project_id=PROJECT_ID"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    }
}

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID"}' \
  "https://api.llmpulse.ai/api/v1/custom_reports/42/send"

const response = await fetch("https://api.llmpulse.ai/api/v1/custom_reports/42/send", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID"})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/custom_reports/42/send",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id": "PROJECT_ID"}
)
data = response.json()

require 'httparty'
require 'json'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/custom_reports/42/send",
  headers: {
    "Authorization" => "Bearer YOUR_API_KEY",
    "Content-Type" => "application/json"
  },
  body: { "project_id" => "PROJECT_ID" }.to_json
)
data = response.parsed_response

package main

import (
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/custom_reports/42/send", strings.NewReader(`{"project_id":"PROJECT_ID"}`))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/custom_reports/42/send"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\"}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    }
}

Relatórios personalizados

GET/custom_reports

GET/custom_reports/:id

POST/custom_reports/:id/send

GET`/custom_reports`

GET`/custom_reports/:id`

POST`/custom_reports/:id/send`