All documentation
Documentation
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.
To read the same report row by row as JSON, use Get payout report data.
All requests require X-Application-Id, X-Api-Key, and the payouts:read scope.
Path parameter
campaignCreatorRecordId(required): the campaign creator to report on.
Query parameters
startDate(required): first included activity date inYYYY-MM-DDformat.endDate(required): last included activity date inYYYY-MM-DDformat.
The dates are interpreted in the campaign's time zone.
Example request
curl -sS "$BASE_URL/sdk/v1/campaign-creators/CCR_123/payout-report?startDate=2026-07-01&endDate=2026-07-31" \
-H "X-Application-Id: $APP_ID" \
-H "X-Api-Key: $API_KEY" \
--output creator-payout-report.pdf
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 range401: missing or invalid SDK credentials403: missingpayouts:readscope, SDK access disabled, or origin not allowed404: campaign creator record not found413: the report exceeds 10,000 rows; use a shorter date range
