API · Platform · Reports
Create a report run.
Starts an async report run. Returns 202 Accepted with status: pending. Subscribe to report_run.succeeded for a signed download_url, or poll GET /v1/reports/runs/{id}.
Report types: - portfolio_compliance_coverage — coverage matrix across a portfolio's entities for a specified compliance window. CSV + JSON. - cap_table_snapshot — full cap-table at a specified as-of date. XLSX. - audit_log_export — entity or account-wide audit log for a date range. JSONL. - filing_history — every filing (past and pending) for an entity. CSV.
Returns 202 Accepted. On completion, emits one of: report.completed. Subscribe via `POST /v1/webhook_endpoints` to consume.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
report_typestringRequired"portfolio_compliance_coverage""cap_table_snapshot""audit_log_export""filing_history"parametersobjectRequiredformatstringOptional"csv""json""jsonl""xlsx"metadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/reports/runs" \ -H "Content-Type: application/json" \ -d '{ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {} }'const body = JSON.stringify({ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {}})fetch("https://api.mattermode.com/v1/reports/runs", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/reports/runs" body := strings.NewReader(`{ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {} }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {}}resp = requests.post( "https://api.mattermode.com/v1/reports/runs", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {}}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/reports/runs")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {}}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/reports/runs", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/reports/runs' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {}}'const response = await fetch("https://api.mattermode.com/v1/reports/runs", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "report_type": "portfolio_compliance_coverage", "parameters": {}, "format": "csv", "metadata": {} }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "string",
"object": "report_run",
"report_type": "portfolio_compliance_coverage",
"status": "pending",
"parameters": {},
"format": "csv",
"result": {},
"error": {},
"started_at": 0,
"finished_at": 0,
"metadata": {},
"created": 1745539200,
"updated": 1745539200,
"livemode": false
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}