Campaign top performers
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers', 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://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"campaignId": "<string>",
"definition": "<string>",
"segmentGroups": [
{
"segment": "<string>",
"segmentScoped": true,
"scoredCount": 123,
"entries": [
{
"creatorId": "<string>",
"scoreStatus": "<string>",
"headlineMeasure": 123,
"percentile": 123,
"segmentPopulation": 123,
"reliability": {
"contractCompletionRate": 123
},
"stale": true
}
]
}
],
"excluded": {
"insufficientData": 123,
"inactive": 123,
"neverScored": 123,
"note": "<string>"
},
"rosterCreators": 123,
"rosterTruncated": true,
"rosterCap": 123,
"caveats": [
"<string>"
],
"meta": {
"runId": "<string>",
"dataSnapshotAt": "<string>",
"algorithmVersion": "<string>",
"definitions": "<string>"
},
"warnings": []
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Campaign top performers
the OWN campaign’s per-segment standout creators (recognition framing). Requires the brand-performance:read scope.
GET
/
performance
/
campaigns
/
{campaignId}
/
top-performers
Campaign top performers
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers', 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://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/performance/campaigns/{campaignId}/top-performers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"campaignId": "<string>",
"definition": "<string>",
"segmentGroups": [
{
"segment": "<string>",
"segmentScoped": true,
"scoredCount": 123,
"entries": [
{
"creatorId": "<string>",
"scoreStatus": "<string>",
"headlineMeasure": 123,
"percentile": 123,
"segmentPopulation": 123,
"reliability": {
"contractCompletionRate": 123
},
"stale": true
}
]
}
],
"excluded": {
"insufficientData": 123,
"inactive": 123,
"neverScored": 123,
"note": "<string>"
},
"rosterCreators": 123,
"rosterTruncated": true,
"rosterCap": 123,
"caveats": [
"<string>"
],
"meta": {
"runId": "<string>",
"dataSnapshotAt": "<string>",
"algorithmVersion": "<string>",
"definitions": "<string>"
},
"warnings": []
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Path Parameters
The campaignId.
Response
Success. Returns the resource envelope.
Standout creators on one of your own campaigns, grouped by segment.
Show child attributes
Show child attributes
⌘I