cURL
curl --request GET \
--url https://firstpromoter.com/api/v1/reports/campaigns \
--header 'X-API-KEY: <api-key>'import requests
url = "https://firstpromoter.com/api/v1/reports/campaigns"
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://firstpromoter.com/api/v1/reports/campaigns', 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://firstpromoter.com/api/v1/reports/campaigns",
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://firstpromoter.com/api/v1/reports/campaigns"
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://firstpromoter.com/api/v1/reports/campaigns")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firstpromoter.com/api/v1/reports/campaigns")
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[
{
"campaign_name": "Test Campaign",
"campaign_id": 18519,
"items": [
{
"revenue_amount": "$613.17",
"clicks_count": 100,
"referrals_count": 60,
"customers_count": 30,
"period": "Sep 2024"
}
],
"revenue_amount": "$613.17",
"clicks_count": 100,
"referrals_count": 60,
"customers_count": 30
}
]"Bad credentials"{
"message": "Selected Fields invalid !",
"code": "invalid_params"
}Reports
Campaign reports
Get report data grouped by campaign over a date range, refreshed every 15 minutes (legacy v1 API).
GET
/
campaigns
cURL
curl --request GET \
--url https://firstpromoter.com/api/v1/reports/campaigns \
--header 'X-API-KEY: <api-key>'import requests
url = "https://firstpromoter.com/api/v1/reports/campaigns"
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://firstpromoter.com/api/v1/reports/campaigns', 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://firstpromoter.com/api/v1/reports/campaigns",
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://firstpromoter.com/api/v1/reports/campaigns"
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://firstpromoter.com/api/v1/reports/campaigns")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firstpromoter.com/api/v1/reports/campaigns")
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[
{
"campaign_name": "Test Campaign",
"campaign_id": 18519,
"items": [
{
"revenue_amount": "$613.17",
"clicks_count": 100,
"referrals_count": 60,
"customers_count": 30,
"period": "Sep 2024"
}
],
"revenue_amount": "$613.17",
"clicks_count": 100,
"referrals_count": 60,
"customers_count": 30
}
]"Bad credentials"{
"message": "Selected Fields invalid !",
"code": "invalid_params"
}With this endpoint you can get the report data grouped by campaigns. Data is updated every
15 minutesQuery Parameters
An array of fields to return on the response. By default selected fields are revenue_amount, clicks_count, referrals_count, customers_count.
Available options:
revenue_amount, clicks_count, referrals_count, customers_count, active_customers, monthly_churn, net_revenue_amount, sales_count, refunds_count, cancelled_customers_count, promoter_earnings_amount, non_link_customers, referrals_to_customers_cr, 3m_epc, 6m_epc, clicks_to_customers_cr, clicks_to_referrals_cr, promoter_paid_amount Response
Campaign report response