Skip to content
Report Templates

Create a report template

POST/api/v1alpha1/report-templates

Creates a report-template head and immutable version 1.

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key?string

Optional key for safe retry of this POST. The key is retained for 24 hours and compared with the request payload and concrete path parameters.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/v1alpha1/report-templates" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "blocks": [      {        "answer_key": "",        "columns": [          {            "key": "",            "label": ""          }        ],        "field_labels": [          {            "key": "",            "label": ""          }        ],        "group_by": "",        "label": "",        "mapping": {},        "sort_by": "",        "sort_direction": "asc",        "type": "timeline"      }    ],    "description": "Reusable report presentation.",    "language": "ja",    "name": "Warehouse safety report"  }'
{  "anonymous": false,  "created_at": "2026-08-22T10:00:00.000Z",  "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "description": "Reusable report presentation.",  "id": "tpl_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "latest_version": 3,  "name": "Warehouse safety report",  "status": "active",  "updated_at": "2026-08-22T10:00:00.000Z",  "updated_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"}