client.reports.list

A method of the Reports endpoint.

list(*, type: str = None, template_id: int = None, author: str = None, hidden: bool = None, archived: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List Reports

API URL: GET /reports

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

Parameters:

typestr, optional

If specified, return report of these types. It accepts a comma-separated list, possible values are ‘tableau’ or ‘other’.

template_idint, optional

If specified, return reports using the provided Template.

authorstr, optional

If specified, return items from any of these authors. It accepts a comma- separated list of user IDs.

hiddenbool, optional

If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

archivedstr, optional

The archival status of the items to return. One of: true, false, all. A blank value is read as ‘false’, which is also the default.

limitint, optional

Number of results to return. Defaults to 20. Maximum allowed is 50.

page_numint, optional

Page number of the results to return. Defaults to the first page, 1.

orderstr, optional

The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.

order_dirstr, optional

Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

iteratorbool, optional

If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse

• 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

• archivedbool

  The archival status of the requested item(s).

• projectsList[civis.Response]

  A list of projects containing the report.

  • idint

    The ID for the project.

  • namestr

    The name of the project.

• statestr

  The status of the report’s last run.

• finished_atstr (time)

  The time that the report’s last run finished.

• viz_updated_atstr (time)

  The time that the report’s visualization was last updated.

• scriptcivis.Response

  • idint

    The ID for the script.

  • namestr

    The name of the script.

  • sqlstr

    The raw SQL query for the script, if applicable.

• job_pathstr

  The link to details of the job that backs this report.

• tableau_id : int

• template_idint

  The ID of the template used for this report.

• auth_thumbnail_urlstr

  URL for a thumbnail of the report.

• last_runcivis.Response

  • id : int

  • statestr

    The state of the run. One of queued, running, succeeded, failed or cancelled.

  • created_atstr (time)

    The time that the run was queued.

  • started_atstr (time)

    The time that the run started.

  • finished_atstr (time)

    The time that the run completed.

  • errorstr

    The error message for this run, if present.