Get the affiliate dashboard summary
curl --request GET \
--url https://api.getoneprofile.ai/affiliate/summary/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/affiliate/summary/"
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/summary/', 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/summary/",
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/summary/"
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/summary/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/affiliate/summary/")
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{
"code": "<string>",
"display_name": "<string>",
"link": "<string>",
"profile": {
"contact_email": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identity_verified_at": "2023-11-07T05:31:56Z",
"paypal_email": "<string>",
"paypal_email_confirmed_at": "2023-11-07T05:31:56Z",
"status": "active"
},
"program": {
"conversion_deadline_days": 123,
"duration_months": 123,
"launch_offer_active": true,
"launch_offer_ends_on": "2023-12-25",
"payout_minimum_cents": 123,
"pending_days": 123,
"rate_bps": 123,
"standard_duration_months": 123,
"standard_rate_bps": 123
},
"stats": {
"available_cents": 123,
"lifetime_earned_cents": 123,
"lifetime_paid_cents": 123,
"paying_count": 123,
"pending_cents": 123,
"registered_count": 123
},
"status": "active",
"vanity_code": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}affiliate
Get the affiliate dashboard summary
Standing, codes, the shareable link, the headline stats and the program terms — everything the dashboard’s overview needs in one read.
GET
/
affiliate
/
summary
/
Get the affiliate dashboard summary
curl --request GET \
--url https://api.getoneprofile.ai/affiliate/summary/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/affiliate/summary/"
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/summary/', 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/summary/",
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/summary/"
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/summary/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/affiliate/summary/")
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{
"code": "<string>",
"display_name": "<string>",
"link": "<string>",
"profile": {
"contact_email": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identity_verified_at": "2023-11-07T05:31:56Z",
"paypal_email": "<string>",
"paypal_email_confirmed_at": "2023-11-07T05:31:56Z",
"status": "active"
},
"program": {
"conversion_deadline_days": 123,
"duration_months": 123,
"launch_offer_active": true,
"launch_offer_ends_on": "2023-12-25",
"payout_minimum_cents": 123,
"pending_days": 123,
"rate_bps": 123,
"standard_duration_months": 123,
"standard_rate_bps": 123
},
"stats": {
"available_cents": 123,
"lifetime_earned_cents": 123,
"lifetime_paid_cents": 123,
"paying_count": 123,
"pending_cents": 123,
"registered_count": 123
},
"status": "active",
"vanity_code": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
APIKeyHeaderHTTPBearer
Response
Successful Response
Everything the affiliate dashboard's overview needs in one read.
The minted default code.
The full URL to share, using the vanity code when claimed.
The caller's own standing in the affiliate program.
Show child attributes
Show child attributes
What the affiliate program pays right now — the public half of the offer.
Show child attributes
Show child attributes
The affiliate dashboard's headline numbers.
Show child attributes
Show child attributes
Whether an affiliate may earn and be paid.
Available options:
active, suspended, banned The claimed custom code, when one exists.
Was this page helpful?