Reports

Render a report or export as a file

Builds the file on the server from the tasks you can see, stores it for 30 days and returns where to fetch it. At most 5000 rows per file. Cells that would execute as spreadsheet formulas are neutralised in CSV. This is the same engine behind the assistant's create_report tool.

post/reports

Request

  • Base URL: https://tasg.app/api/v1
  • URL: https://tasg.app/api/v1/reports
  • Auth: HTTP bearer

Request body

template'task_list' | 'status_report' | 'workload'

task_list: rows of tasks. status_report: headline figures, an optional narrative and tasks by section (needs project_id). workload: open tasks per person.

format'xlsx' | 'csv' | 'pdf' | 'md'
titlestring

File and document title; defaults to the project or workspace name plus the template.

narrativestring

Short prose placed above the tables (blank-line separated paragraphs).

project_idstring uuid

One project. Either this or workspace_id is required.

workspace_idstring uuid

A cross-project report over one workspace; ignored when project_id is set.

group_by'section' | 'assignee' | 'status' | 'priority' | 'project' | 'none'

Defaults to section for a project, project for a workspace.

columnsstring[]

Column pick for task_list; default omits description and url.

deliver_to'chat' | 'task' | 'email'

chat: stored only. task: also attached to task_id. email: also emailed to the caller (never anyone else).

task_idstring uuid

Required when deliver_to is task.

Response

Rendered and stored.

idstring uuid required
filenamestring required
mime_typestring required
file_sizeinteger required

Bytes.

row_countinteger required
template'task_list' | 'status_report' | 'workload' required
format'xlsx' | 'csv' | 'pdf' | 'md' required
delivered_to'chat' | 'task' | 'email' required
urlstring required

Relative download path; send your bearer token.

download_urlstring nullable required

Absolute link that works WITHOUT a bearer token for 24 hours (signed, bound to this file). Null when the instance cannot sign links.

created_atstring date-time required
expires_atstring date-time required

Files are deleted after 30 days.

Changes

No recorded changes to this operation across all 1 revision of this API.