client.reports.post_services

A method of the Reports endpoint.

post_services(service_id: int, *, provide_api_key: bool = None) → Response

Create a service report

API URL: POST /reports/services

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

Parameters:

service_idint

The id of the backing service

provide_api_keybool, optional

Whether the report requests an API Key from the report viewer.

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”.

• archivedbool

  The archival status of the requested item(s).

• hoststr

  The host for the service report

• display_urlstr

  The URL to display the service report.

• service_idint

  The id of the backing service

• provide_api_keybool

  Whether the report requests an API Key from the report viewer.

• api_keystr

  A Civis API key that can be used by this report.

• api_key_idint

  The ID of the API key. Can be used for auditing API use by this report.