client.reports.patch_sql

A method of the Reports endpoint.

patch_sql(id: int, *, query_id: int = None, name: str = None, config: str = None, description: str = None) → Response

Update a SQL report

API URL: PATCH /reports/sql/{id}

import civis
client = civis.APIClient()
response = client.reports.patch_sql(...)

Parameters:

idint: The ID of this report.
query_idint, optional: The ID of the query used to create this report.
namestr, optional: The name of the report.
configstr, optional: The configuration of the report visualization.
descriptionstr, optional: The user-defined description of the report.

Returns:

civis.Response

idint
The ID of this report.
namestr
The name of the report.
usercivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
created_atstr (time)
The creation time for this report.
updated_atstr (time)
The last updated at time for this report.
typestr
The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL, ReportTypes::QuickAnalysis, ReportTypes::QuickDashboard
descriptionstr
The user-defined description of the report.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
configstr
The configuration of the report visualization.
querycivis.Response
- idint
  The query ID.
- databaseint
  The database ID.
- sqlstr
  The SQL to execute.
- credentialint
  The credential ID.
- result_rowsList[List]
  A preview of rows returned by the query.
- result_columnsList[str]
  A preview of columns returned by the query.
- errorstr
  The error message for this run, if present.
- started_atstr (date-time)
  The start time of the last run.
- finished_atstr (date-time)
  The end time of the last run.
- statestr
  The state of the last run. One of queued, running, succeeded, failed, and cancelled.
- running_ascivis.Response
  
  idint
  The ID of this user.
  
  namestr
  This user’s name.
  
  usernamestr
  This user’s username.
  
  initialsstr
  This user’s initials.
  
  onlinebool
  Whether this user is online.