v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Stats

POST - Export the current results of a custom report

Request an export of a custom report using the custom report's key.
The export will be sent to the supplied teammate's email.
Each custom report can only be exported once every 2 hours and each teammate email is limited to 20 exports every 2 hours.
A 429 error will be returned if the request exceeds the rate limit.
Note: Exports can take up to 30 minutes to generate.

post/v2/vendor_report_export/{vendor_report_configuration_key}

Path parameters

vendor_report_configuration_keystring required

Unique identifier for which custom report to export

Request body

member_emailstring nullable

The email of the company member that should receive the export email (Note: This user must have access to your PartnerStack instance)

show_unexpandedboolean nullable

webhook_target_urlstring nullable

The webhook target URL to send the export to

Example request

{
  "member_email": "vladmir.tepes@wallachia.com"
}

Response

Request an export of a custom report using the custom report's key.
The export will be sent to the supplied teammate's email.
Each custom report can only be exported once every 2 hours and each teammate email is limited to 20 exports every 2 hours.
A 429 error will be returned if the request exceeds the rate limit.
Note: Exports can take up to 30 minutes to generate.

messagestring required

statusinteger required