Skip to main content

GET /sdk/v1/campaign-creators/:campaignCreatorRecordId/payout-report

Returns the campaign creator’s payout report as PDF data. You can display the response in a browser, embed it in a PDF viewer, or save it as a file. All requests require X-Application-Id and X-Api-Key.

Path parameter

  • campaignCreatorRecordId (required): the campaign creator to report on.

Query parameters

  • startDate (required): first included activity date in YYYY-MM-DD format.
  • endDate (required): last included activity date in YYYY-MM-DD format.
The dates are interpreted in the campaign’s time zone.

Example request

Response

  • Content type: application/pdf
  • Content disposition: inline
  • Body: raw PDF bytes
This endpoint does not return a JSON success wrapper when the report is generated successfully.

Common errors

  • 400: missing or invalid date range
  • 401: missing or invalid SDK credentials
  • 404: campaign creator record not found
  • 413: the report exceeds 10,000 rows; use a shorter date range