Skip to main content

Get performance statistics (conversion)

GET 
/v1/partnership/reports/conversion

Analyze how referred clients progress from a link click through registration, deposit, trading, and reward. Group the funnel by one dimension, such as date, campaign, link, country, or referrer, then use filters to narrow the selected population.

Required scopes:

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

Rules:

  • When group_by is day, both date_from and date_to are required and the period must not exceed 180 days.
  • ordering is required. Supply at least one supported sort field, for example -day when group_by=day. A missing or empty value returns HTTP 400.
  • Use limit and offset together to paginate the result set.
  • Keep the same filter set and ordering while retrieving additional pages.

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

Request​

Responses​

Successful response.