civis (version 3.1.3)

reports_get_services: Get a single service report

Description

Get a single service report

Usage

reports_get_services(id)

Value

A list containing the following elements:

id

integer, The ID of this report.

name

string, The name of the report.

user

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

createdAt

string, The creation time for this report.

updatedAt

string, The last updated at time for this report.

type

string, The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL

description

string, The user-defined description of the report.

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".

archived

string, The archival status of the requested item(s).

host

string, The host for the service report

displayUrl

string, The URL to display the service report.

serviceId

integer, The id of the backing service

provideAPIKey

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

apiKey

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

apiKeyId

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

Arguments

id

integer required. The ID of this report.