curl --request GET \
--url https://api.getoneprofile.ai/affiliate/performance/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/affiliate/performance/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/affiliate/performance/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/affiliate/performance/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/affiliate/performance/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/affiliate/performance/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/affiliate/performance/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"active_count": 123,
"average_commission_cents": 123,
"clears_minimum_on": "2023-12-25",
"clicks": {
"current": 123,
"previous": 123
},
"conversion_rate": 123,
"conversions": {
"current": 123,
"previous": 123
},
"days": 123,
"earned_cents": {
"current": 123,
"previous": 123
},
"epc_cents": 123,
"held_cents": 123,
"last_commission_at": "2023-11-07T05:31:56Z",
"last_conversion_at": "2023-11-07T05:31:56Z",
"last_signup_at": "2023-11-07T05:31:56Z",
"lifetime_clawed_back_cents": 123,
"lifetime_gross_cents": 123,
"lifetime_net_cents": 123,
"never_paid_count": 123,
"next_payout_blocker": "<string>",
"next_payout_cents": 123,
"next_payout_on": "2023-12-25",
"next_payout_status": "paused",
"signup_rate": 123,
"signups": {
"current": 123,
"previous": 123
},
"upcoming_maturities": [
{
"amount_cents": 123,
"day": "2023-12-25",
"running_available_cents": 123
}
],
"window_closed_count": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Get the affiliate performance figures
The overview’s whole measurement surface in one read: the click, signup, conversion and earnings funnel over a window with each step against the equally long window before it; the rates over those steps; lifetime gross, clawed-back and net commission; where the referral roster stands; when pending commission matures; and what the next monthly payout run would send. A rate whose denominator is too small to state honestly comes back null rather than as a number nobody should act on.
curl --request GET \
--url https://api.getoneprofile.ai/affiliate/performance/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/affiliate/performance/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/affiliate/performance/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/affiliate/performance/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/affiliate/performance/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/affiliate/performance/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/affiliate/performance/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"active_count": 123,
"average_commission_cents": 123,
"clears_minimum_on": "2023-12-25",
"clicks": {
"current": 123,
"previous": 123
},
"conversion_rate": 123,
"conversions": {
"current": 123,
"previous": 123
},
"days": 123,
"earned_cents": {
"current": 123,
"previous": 123
},
"epc_cents": 123,
"held_cents": 123,
"last_commission_at": "2023-11-07T05:31:56Z",
"last_conversion_at": "2023-11-07T05:31:56Z",
"last_signup_at": "2023-11-07T05:31:56Z",
"lifetime_clawed_back_cents": 123,
"lifetime_gross_cents": 123,
"lifetime_net_cents": 123,
"never_paid_count": 123,
"next_payout_blocker": "<string>",
"next_payout_cents": 123,
"next_payout_on": "2023-12-25",
"next_payout_status": "paused",
"signup_rate": 123,
"signups": {
"current": 123,
"previous": 123
},
"upcoming_maturities": [
{
"amount_cents": 123,
"day": "2023-12-25",
"running_available_cents": 123
}
],
"window_closed_count": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Query Parameters
The window these figures cover.
1 <= x <= 365Response
Successful Response
Everything the affiliate overview measures over one window.
Referrals still inside their commission window.
Lifetime gross commission per paying referral. Null with none yet.
The day the payable balance first clears the payout minimum on that schedule. Null when it already has, or when it never does.
One metric over a window, against the window immediately before it.
Show child attributes
Show child attributes
Paying referrals per signup, lifetime, 0-1. Null below the honesty floor.
One metric over a window, against the window immediately before it.
Show child attributes
Show child attributes
The window length these figures cover.
One metric over a window, against the window immediately before it.
Show child attributes
Show child attributes
Commission earned per click over the window. Null below the honesty floor.
Money in a payout waiting on human review. Still counted in the available balance until it is released.
What refunds and disputes took back, as a positive magnitude.
Referrals that have not started a paid plan.
When blocked, which gate: identity_not_verified, no_payout_email or destination_hold.
What that run would send on today's numbers plus what matures before it.
The date of the next monthly payout run.
Whether that run will actually send anything: scheduled, below the minimum, blocked on a step the affiliate can take, under human review, paused program-wide, or unavailable to this account.
paused, unavailable, under_review, blocked, below_minimum, scheduled Signups per click over the window, 0-1. Null when there were too few clicks for the figure to mean anything.
One metric over a window, against the window immediately before it.
Show child attributes
Show child attributes
The next days pending commission becomes payable on, soonest first.
Show child attributes
Show child attributes
Referrals whose commission window has ended.
Was this page helpful?