List program pay structures
curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures"
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures', 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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures",
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures"
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures")
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{
"programId": "<string>",
"trial": {
"limit": {
"kind": "days",
"count": 123
},
"goal": {
"kind": "views",
"targetViews": 123,
"passingVideoCount": 123
},
"failureAction": "remove",
"nextPayscaleId": "<string>",
"skipTopCreators": true
},
"data": [
{
"id": "<string>",
"label": "<string>",
"isDefault": true,
"isTrial": true,
"fallbackPay": {
"payoutType": "view_bonus",
"platformPayoutMode": "per_post",
"viewTrackingDays": 123,
"trialCutoff": {
"views": 123,
"posts": 123,
"days": 123,
"enabled": true
},
"perCreatorCap": {
"enabled": true,
"capCents": 123,
"periodDays": 123
},
"inactivityCutoff": {
"enabled": true,
"days": 123
},
"baseRateDisabled": true,
"tiers": [
{
"viewsThreshold": 123,
"bonusCents": 123
}
],
"cpmCents": 123,
"minViews": 123,
"maxViews": 123,
"flatFeeCents": 123,
"amountCents": 123,
"flatFee": {
"enabled": true,
"flatFeeCents": 123,
"minViews": 123
},
"monthlyInput": {
"budgetCents": 123,
"postsPerMonth": 123,
"videosPerMonth": 123
},
"perPlatform": {}
},
"contentRules": [
{
"id": "<string>",
"label": "<string>",
"matcher": {
"kind": "content",
"description": "<string>",
"thresholdViews": 123
},
"pay": {
"payoutType": "view_bonus",
"platformPayoutMode": "per_post",
"viewTrackingDays": 123,
"trialCutoff": {
"views": 123,
"posts": 123,
"days": 123,
"enabled": true
},
"perCreatorCap": {
"enabled": true,
"capCents": 123,
"periodDays": 123
},
"inactivityCutoff": {
"enabled": true,
"days": 123
},
"baseRateDisabled": true,
"tiers": [
{
"viewsThreshold": 123,
"bonusCents": 123
}
],
"cpmCents": 123,
"minViews": 123,
"maxViews": 123,
"flatFeeCents": 123,
"amountCents": 123,
"flatFee": {
"enabled": true,
"flatFeeCents": 123,
"minViews": 123
},
"monthlyInput": {
"budgetCents": 123,
"postsPerMonth": 123,
"videosPerMonth": 123
},
"perPlatform": {}
}
}
]
}
]
}Programs
List program pay structures
List every payscale on a Canvas program, with the ids that the two pay-structure changes accept, and the program’s trial rule.
GET
/
programs
/
{id}
/
pay-structures
List program pay structures
curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures"
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures', 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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures",
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures"
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://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/programs/{id}/pay-structures")
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{
"programId": "<string>",
"trial": {
"limit": {
"kind": "days",
"count": 123
},
"goal": {
"kind": "views",
"targetViews": 123,
"passingVideoCount": 123
},
"failureAction": "remove",
"nextPayscaleId": "<string>",
"skipTopCreators": true
},
"data": [
{
"id": "<string>",
"label": "<string>",
"isDefault": true,
"isTrial": true,
"fallbackPay": {
"payoutType": "view_bonus",
"platformPayoutMode": "per_post",
"viewTrackingDays": 123,
"trialCutoff": {
"views": 123,
"posts": 123,
"days": 123,
"enabled": true
},
"perCreatorCap": {
"enabled": true,
"capCents": 123,
"periodDays": 123
},
"inactivityCutoff": {
"enabled": true,
"days": 123
},
"baseRateDisabled": true,
"tiers": [
{
"viewsThreshold": 123,
"bonusCents": 123
}
],
"cpmCents": 123,
"minViews": 123,
"maxViews": 123,
"flatFeeCents": 123,
"amountCents": 123,
"flatFee": {
"enabled": true,
"flatFeeCents": 123,
"minViews": 123
},
"monthlyInput": {
"budgetCents": 123,
"postsPerMonth": 123,
"videosPerMonth": 123
},
"perPlatform": {}
},
"contentRules": [
{
"id": "<string>",
"label": "<string>",
"matcher": {
"kind": "content",
"description": "<string>",
"thresholdViews": 123
},
"pay": {
"payoutType": "view_bonus",
"platformPayoutMode": "per_post",
"viewTrackingDays": 123,
"trialCutoff": {
"views": 123,
"posts": 123,
"days": 123,
"enabled": true
},
"perCreatorCap": {
"enabled": true,
"capCents": 123,
"periodDays": 123
},
"inactivityCutoff": {
"enabled": true,
"days": 123
},
"baseRateDisabled": true,
"tiers": [
{
"viewsThreshold": 123,
"bonusCents": 123
}
],
"cpmCents": 123,
"minViews": 123,
"maxViews": 123,
"flatFeeCents": 123,
"amountCents": 123,
"flatFee": {
"enabled": true,
"flatFeeCents": 123,
"minViews": 123
},
"monthlyInput": {
"budgetCents": 123,
"postsPerMonth": 123,
"videosPerMonth": 123
},
"perPlatform": {}
}
}
]
}
]
}