list_report_templates
List report templates available to your organization — both system-shipped and org-authored.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
include_system | boolean | no | true | Include Adlyse-shipped templates alongside org-owned ones |
Returns#
json
{
"templates": [
{
"id": "ad_rtpl_abc",
"key": "weekly_check_in",
"version": 1,
"name": "Weekly Check-In",
"description": "Quick 7-day status read with wins/concerns.",
"is_system": true,
"default_period_days": 7,
"sections": ["cover", "executive_summary", "abi", "headline_metrics", "top_campaigns", "ai_insights", "footer"]
}
],
"count": 1,
"source": "adlyse.report_templates@v1"
}| Field | Description |
|---|---|
templates[].key | Stable identifier — use in generate_report |
templates[].version | Bumped on every edit; active versions only are returned |
templates[].is_system | true for Adlyse-shipped templates |
templates[].default_period_days | Recommended lookback window when not overridden |
templates[].sections | Ordered list of section keys the template renders |
System template keys#
weekly_check_in(7-day window)monthly_performance(30-day window)optimization_activity_log(decision-log digest)executive_kpi_summary(short, numbers-first)qbr_quarterly(quarterly review)
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
Example#
Response (truncated):
json
{
"templates": [
{ "key": "weekly_check_in", "name": "Weekly Check-In", "is_system": true, "default_period_days": 7 },
{ "key": "monthly_performance", "name": "Monthly Performance", "is_system": true, "default_period_days": 30 },
{ "key": "my_custom_digest", "name": "Our Weekly Digest", "is_system": false, "default_period_days": 7 }
],
"count": 3,
"source": "adlyse.report_templates@v1"
}See also#
generate_report— use thekeyfrom this listing- Reports — authoring custom templates