Custom Reports

The custom reports built in the app's Custom Reports section: list them, read one with the data of every widget as its page shows it, and email it to its recipients now. Scale plan and above. Recipient addresses, the shared-link token and the password are never returned.

GET`/custom_reports`

The custom reports of the project, newest first, with their date range, delivery schedule, recipient count, whether the shared link is published, and the widgets each one shows. Also available as the MCP tool list_custom_reports.

Params:

project_idrequired
page
per_pagedefault 20, max 100
output

GET`/custom_reports/:id`

One report's configuration (date range, model, tag, brand type and competitor filters, schedule, layout) and the data of every widget computed now, the same numbers its page, shared link and PDF show. Each widget has a kind and a data object shaped by it: series (timeseries), slices (donut), bars (bar), values and changes (kpi_grid) or rows (table). A widget whose data source is not connected has available: false. Read-only. Also available as the MCP tool get_custom_report.

Params:

project_idrequired
:idin URL

Returns ERR_NOT_FOUND for a report outside the project.

POST`/custom_reports/:id/send`

Email the report to its recipients now, like the Send now button on the report page: the report must be published and have at least one recipient (ERR_INVALID_PARAM otherwise), and each report can be sent once every 10 minutes (429 ERR_RATE_LIMITED with Retry-After). Returns 202 once the PDF is queued. Not available from a white-label portal or for a report made inside one (ERR_INTEGRATION_UNAVAILABLE). Requires a writable API key and, for team members, update permission on Custom Reports. Also available as the MCP tool send_custom_report.

Path:

:idreport id

Body (JSON): project_id (required).

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/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());
    }
}

Custom Reports

GET/custom_reports

GET/custom_reports/:id

POST/custom_reports/:id/send

GET`/custom_reports`

GET`/custom_reports/:id`

POST`/custom_reports/:id/send`