GET /statistics/conversions/rate

Get conversion rate by day

Statistics

Description

Retrieve daily conversion rate statistics for your affiliate business.
Returns a time series of conversion rates (percentage of redirects that resulted in transactions) grouped by day.
Conversion rate is calculated as: (transactions / redirects) * 100

Authentication Required: User must be authenticated and have the 'affiliate' role.

Users can only query their own affiliate_id.

Parameters

affiliate_id integer query required
The affiliate ID to get conversion rate statistics for
start_date string query
Start date for the statistics range (ISO 8601 format). Defaults to 30 days ago.
end_date string query
End date for the statistics range (ISO 8601 format). Defaults to current time.
exclude_bots boolean query
Exclude bot traffic from both redirects and transactions when calculating conversion rate. Defaults to false (includes bot traffic).
reward_status string query
Filter conversions by reward status when calculating the conversion rate. When omitted, all reward statuses are included.

Responses

200 Successful response with daily conversion rates
application/json
statusstring
Example: success
dataarray
Array of daily conversion rates, returns 0 when there are no redirects
Example:
{
  "status": "success",
  "data": [
    {
      "date": "2024-01-01",
      "conversion_rate": 26.6667
    },
    {
      "date": "2024-01-02",
      "conversion_rate": 0
    },
    {
      "date": "2024-01-03",
      "conversion_rate": 26.8657
    },
    {
      "date": "2024-01-04",
      "conversion_rate": 39.1304
    }
  ]
}
401 Authentication required
application/json
Example:
{
  "status": "error",
  "message": "Not authenticated or insufficient permissions"
}
500 Internal server error
application/json
statusstring
Example: error
messagestring
Example: Failed to fetch conversion rate statistics
errorstring
Example: Connection error