Comparteix a través de

Blackbaud RENXT Reports (Preview)

  • Reference

Blackbaud Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community. Use the Reports connector to manage and execute reports.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Contact
Name Blackbaud Support
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Connector Metadata
Publisher Blackbaud, Inc.
Website https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Privacy policy https://www.blackbaud.com/privacy-shield
Categories Sales and CRM;Productivity

Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community.

This connector is built on top of Blackbaud's SKY API, and provides functionality to manage and execute reports found within Raiser's Edge NXT.

For more information, please view the documentation.

Prerequisites

To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.

In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.

How to get credentials?

Your organization's administrator will send you an invitation to the organization's Raiser's Edge NXT environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.

Known issues and limitations

The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get report job status

Returns information about a background report execution job.
List report instances

Lists the instances for the specified report type.
List report jobs

Lists recent report jobs executed by the current user in the last 7 days.
Start a report execution job

Starts a background job to execute the specified report.

Get report job status

Operation ID:
GetReportJobStatus

Returns information about a background report execution job.

Parameters

Name Key Required Type Description
Job ID
 job_id True string

The system record ID of the report execution job.

Returns

Report execution job

Body
ReportApi.ReportExecutionJob

List report instances

Operation ID:
ListReportIntances

Lists the instances for the specified report type.

Parameters

Name Key Required Type Description
Report type
 report_type True integer

The report type.
Only owned?
 only_owned_reports boolean

Return only owned reports?

Returns

Report instances

Body
ReportApi.ReportInstanceCollection

List report jobs

Operation ID:
ListReportJobs

Lists recent report jobs executed by the current user in the last 7 days.

Returns

Report jobs

Body
ReportApi.ReportJobCollection

Start a report execution job

Operation ID:
StartReportExecutionJob

Starts a background job to execute the specified report.

Parameters

Name Key Required Type Description
Report type
 report_type_id True integer

The report type.
Report instance
 report_instance_id True integer

The report instance to execute.
Output format
 output_format True string

Indicates the output format for the report.
Time zone offset
 time_zone_offset_in_minutes integer

The time zone offset expressed in minutes.
Anonymous option
 anonymous_option string

Indicates how to display anonymous donor names.

Returns

Started report job

Body
ReportApi.ExecuteReportResponse

Definitions

ReportApi.ExecuteReportResponse

Started report job

Name Path Type Description
Job IDs
 job_ids array of string

The set of report job identifiers created by the report execution.

ReportApi.ReportExecutionJob

Report execution job

Name Path Type Description
ID
 id string

The report job identifier.
Status
 status string

The report job status.
ID
 report_view.id integer

The report instance identifier.
name
 report_view.name string

The report instance name.
Report results URI
 sas_uri string

The URI for accessing the report results. This URI should be treated as a secure credential to access the report results - the value is considered sensitive, and the URI will expire after 15 minutes.

ReportApi.ReportInstance

Report instance

Name Path Type Description
ID
 id string

The report instance identifier.
Name
 name string

The report instance name.
Description
 description string

The report instance description.
Others can modify?
 others_may_modify boolean

Can other users modify the report instance?
Others can execute?
 others_may_execute boolean

Can other users execute the report?
Last run
 date_last_run date-time

The date when the report was last run.
Processing time
 processing_time string

The processing time of the last run of the report instance (ex: 00:05:06).
Date created
 date_added date-time

The date when the report instance was created.
Created by user ID
 added_by string

The system record ID of the user that created the report instance.
Created by
 added_by_user_name string

The name of the user that created the report instance.
Date changed
 date_modified date-time

The date when the report instance was last changed.
Changed by user ID
 modified_by string

The system record ID of the user that last changed the report instance.
Changed by
 modified_by_user_name string

The name of the user that last changed the report instance.

ReportApi.ReportInstanceCollection

Report instances

Name Path Type Description
items
 items array of ReportApi.ReportInstance

The set of items included in the response.

ReportApi.ReportJob

Report job

Name Path Type Description
ID
 job_id string

The report job identifier.
Report type ID
 report_type_id integer

The report type identifier.
Report type name
 report_type_name string

The report type name.
Report name
 report_name string

The report name.
ID
 report_view.id string

The report instance identifier.
name
 report_view.name string

The report instance name.
Status
 status string

The report job status.
Is scheduled?
 scheduled boolean

Is the report job scheduled?
Output format
 output_format string

The output format for the report.
Total processing time
 total_processing_time string

The total processing time of the report job (ex: 00:05:06).
Total processing time caption
 total_processing_time_caption string

The friendly caption for the total processing time.
Date created
 date_added date-time

The date when the report job was created.
Date completed
 date_completed date-time

The date when the report job completed.

ReportApi.ReportJobCollection

Report jobs

Name Path Type Description
items
 items array of ReportApi.ReportJob

The set of items included in the response.