Reports

class Reports(session_kwargs, client, return_type='raw')

Civis API /reports endpoint.

Methods

delete_grants(id)

Revoke permission for this report to perform Civis platform API operations on your behalf

delete_projects(id, project_id)

Remove a Report from a project

delete_services_projects(id, project_id)

Remove a Service Report from a project

delete_services_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_services_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_sql_projects(id, project_id)

Remove a SQL Report from a project

delete_sql_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_sql_shares_users(id, user_id)

Revoke the permissions a user has on this object

get(id)

Get a single report

get_git(id)

Get the git metadata attached to an item

get_git_commits(id, commit_hash)

Get file contents at git ref

get_refresh(id, job_id)

Get the status of a Tableau extract refresh job

get_services(id)

Get a single service report

get_sql(id)

Get a single SQL report

list(*[, type, template_id, author, hidden, ...])

List Reports

list_dependencies(id, *[, user_id])

List dependent objects for this object

list_git(id)

Get the git metadata attached to an item

list_git_commits(id)

Get the git commits for an item on the current branch

list_projects(id, *[, hidden])

List the projects a Report belongs to

list_services_dependencies(id, *[, user_id])

List dependent objects for this object

list_services_projects(id, *[, hidden])

List the projects a Service Report belongs to

list_services_shares(id)

List users and groups permissioned on this object

list_shares(id)

List users and groups permissioned on this object

list_sql_dependencies(id, *[, user_id])

List dependent objects for this object

list_sql_projects(id, *[, hidden])

List the projects a SQL Report belongs to

list_sql_shares(id)

List users and groups permissioned on this object

patch(id, *[, name, script_id, code_body, ...])

Update a report

patch_git(id, *[, git_ref, git_branch, ...])

Update an attached git file

patch_services(id, *[, name, provide_api_key])

Update some attributes of this service report

patch_sql(id, *[, query_id, name, config, ...])

Update a SQL report

post(*[, script_id, name, code_body, ...])

Create an HTML report

post_git_commits(id, content, message, file_hash)

Commit and push a new version of the file

post_grants(id)

Grant this report the ability to perform Civis platform API operations on your behalf

post_refresh(id)

Refresh the data in this Tableau report

post_services(service_id, *[, provide_api_key])

Create a service report

post_sql(query_id, name, config, *[, ...])

Create a SQL report

post_sql_refresh(id)

Refresh the data in a SQL report

put_archive(id, status)

Update the archive status of this object

put_git(id, *[, git_ref, git_branch, ...])

Attach an item to a file in a git repo

put_projects(id, project_id)

Add a Report to a project

put_services_archive(id, status)

Update the archive status of this object

put_services_projects(id, project_id)

Add a Service Report to a project

put_services_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_services_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_services_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_shares_groups(id, group_ids, ...[, ...])

Set the permissions groups has on this object

put_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_sql_archive(id, status)

Update the archive status of this object

put_sql_projects(id, project_id)

Add a SQL Report to a project

put_sql_shares_groups(id, group_ids, ...[, ...])

Set the permissions groups has on this object

put_sql_shares_users(id, user_ids, ...[, ...])

Set the permissions users have on this object

put_sql_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_transfer(id, user_id, ...[, email_body, ...])

Transfer ownership of this object to another user