Skip to main content
xplainabledocs

Reports

Create and manage model reports.

All methods are accessed via client.reports.

available_widgets()​

Return the available widget tags and their descriptions. Visual widgets (baseValue, confusionMatrix, etc.) should be used at most once per report. Text widgets (h2, p, divider) can repeat.

Returns​

dict

Example​

1result = client.reports.available_widgets()

create_report()​

Start async report generation via the wizard.

Parameters​

run_idstrRequired
report_namestrRequired
report_descriptionstrdefault: ''
is_publicbooldefault: False
widgetslistdefault: None
modestrdefault: 'dynamic'
max_featuresintdefault: 40
constraintsDictdefault: None
audienceDictdefault: None

Returns​

dict — Dict with job_id and status ("accepted")

Example​

1result = client.reports.create_report(
2 run_id="run_abc123",
3 report_name="Model Report",
4 report_description="Detailed analysis",
5 is_public=False,
6 widgets=[],
7 mode="dynamic"
8)

get_job_status()​

Get the status of a wizard report generation job. Pairs with the workflow create_report tool, which starts the wizard and returns the job_id to poll here. Status is one of 'pending' | 'running' | 'done' | 'error'. On 'done' the payload includes the generated report_id and version_id (open the report in the platform UI); on 'error' it includes the error detail. Generation typically finishes in under a minute — if still 'pending' or 'running', wait a few seconds and poll again.

Parameters​

job_idstrRequired

Returns​

dict

Example​

1result = client.reports.get_job_status(
2 job_id="job_abc123"
3)

delete_report()​

Delete a report and all of its versions. This permanently removes the report from the team. Use it to clean up draft or superseded reports created via create_report.

Parameters​

report_idstrRequired
The ID of the report to delete

Returns​

dict — Dict with a confirmation message

Example​

1result = client.reports.delete_report(
2 report_id="..."
3)

create_report_sync()​

Create a report synchronously (polls until complete or timeout).

Parameters​

run_idstrRequired
report_namestrRequired
report_descriptionstrdefault: ''
is_publicbooldefault: False
widgetslistdefault: None
modestrdefault: 'dynamic'
max_featuresintdefault: 40
constraintsDictdefault: None
audienceDictdefault: None
timeoutintdefault: 120
poll_intervalfloatdefault: 2.0

Returns​

dict — Dict with status, report_id, version_id

Example​

1result = client.reports.create_report_sync(
2 run_id="run_abc123",
3 report_name="Model Report",
4 report_description="Detailed analysis",
5 is_public=False,
6 widgets=[],
7 mode="dynamic"
8)