client.templates.get_reports

A method of the Templates endpoint.

get_reports(id: int) Response

Get a Report Template

API URL: GET /templates/reports/{id}

import civis
client = civis.APIClient()
response = client.templates.get_reports(...)
Parameters:
idint
Returns:
civis.Response
  • id : int

  • namestr

    The name of the template.

  • categorystr

    The category of this report template. Can be left blank. Acceptable values are: dataset-viz

  • created_at : str (time)

  • updated_at : str (time)

  • use_countint

    The number of uses of this template.

  • archivedbool

    Whether the template has been archived.

  • tech_reviewedbool

    Whether this template has been audited by Civis for security vulnerability and correctness.

  • authorcivis.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.

  • auth_code_urlstr

    A URL to the template’s stored code body.

  • provide_api_keybool

    Whether reports based on this template request an API Key from the report viewer.

  • hiddenbool

    The hidden status of the item.