Skip to main content

Get progress reward calculation details

GET 
/v1/partnership/reports/progress-reward/:compensation_id/detailed

Return order-level calculation rows for one progress-reward compensation record. Rows show the original and adjusted reward rates and the resulting progress-reward amount.

Required scopes:

  • read: partnership.all:read or partnership.all.

Runtime restrictions:

  • compensation_id must have reward-order rows associated with the partner represented by the API key. Otherwise, the operation returns NotFound.

Rules:

  • Use limit and offset together to paginate the result set.
  • Keep the same filter set and ordering while retrieving additional pages.
  • Only one sort field is applied. Supported fields are progress_reward_amount_usd and reward_date; prefix the field with - for descending order.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • This read operation can be retried. Results may change as report data is updated. Keep the same filters and ordering when reading additional pages, where pagination is supported.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError
  • NotFound

Request​

Responses​

Successful response.