reports_post_services {civis}

Create a service report

Description

Create a service report

Usage

reports_post_services(service_id, provide_api_key = NULL)

Arguments

service_id

integer required. The id of the backing service

provide_api_key

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

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,

updatedAt

string,

myPermissionLevel

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

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.

archived

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