Skip to main content
POST

Overview

Surface fundraising activity across a market segment.

Endpoint Details

  • Method: POST
  • Endpoint: /api/assets/process_common/

Authentication requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

Request

Request Parameters

Header Parameters

Authorization
string
required
JWT token obtained from the Authentication request

Body Parameters

reportType
string
required
fundraisers_workflow
reportSource
string
required
WKLAPP
payload
object
required
Report configuration object
payload.topic
string
required
Industry topic to generate the fundraise report for
payload.workbook_name
string
required
Name to assign to the generated workbook
payload.advanced_settings
object
Advanced filtering options for the report
payload.advanced_settings.company_type
string
Type of company to filter by. Use "all" to include all types
payload.advanced_settings.geography
array
List of geographies to filter by (e.g. ["Worldwide"])
payload.advanced_settings.funding_stage
array
List of funding stages to filter by. Pass an empty array to include all stages
payload.advanced_settings.employee_count
array
List of employee count ranges to filter by. Pass an empty array to include all
payload.advanced_settings.total_funding_include_blanks
boolean
Whether to include companies with no total funding data. Defaults to true

Response

Successful response will include the report_id of the initiated Fundraise report.

Successful Response Fields

report_id
integer
Report id for the initiated Fundraise report

Authorizations

Authorization
string
header
required

JWT token obtained from the /auth/token/ endpoint.

Body

application/json
reportType
enum<string>
default:fundraisers_workflow
required

Fixed value for Fundraising Activity reports.

Available options:
fundraisers_workflow
reportSource
enum<string>
default:WKLAPP
required

Source identifier for the report request.

Available options:
WKLAPP
payload
object
required

Report configuration object.

Response

Report initiated successfully.

report_id
integer

Report ID for the initiated Fundraising Activity report.

Example:

123345