Get campaign entities
curl --request POST \
--url https://backstage.example.com/api/soundcheck/campaigns/entities \
--header 'Content-Type: application/json' \
--data '
{
"campaignId": "<string>",
"campaignName": "<string>",
"checkId": "<string>",
"checkName": "<string>",
"checkStates": [],
"entityFilter": {},
"entityFields": [
"<string>"
],
"metadataAnnotations": [
"<string>"
],
"first": 123,
"after": "<string>"
}
'import requests
url = "https://backstage.example.com/api/soundcheck/campaigns/entities"
payload = {
"campaignId": "<string>",
"campaignName": "<string>",
"checkId": "<string>",
"checkName": "<string>",
"checkStates": [],
"entityFilter": {},
"entityFields": ["<string>"],
"metadataAnnotations": ["<string>"],
"first": 123,
"after": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
campaignId: '<string>',
campaignName: '<string>',
checkId: '<string>',
checkName: '<string>',
checkStates: [],
entityFilter: {},
entityFields: ['<string>'],
metadataAnnotations: ['<string>'],
first: 123,
after: '<string>'
})
};
fetch('https://backstage.example.com/api/soundcheck/campaigns/entities', 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://backstage.example.com/api/soundcheck/campaigns/entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaignId' => '<string>',
'campaignName' => '<string>',
'checkId' => '<string>',
'checkName' => '<string>',
'checkStates' => [
],
'entityFilter' => [
],
'entityFields' => [
'<string>'
],
'metadataAnnotations' => [
'<string>'
],
'first' => 123,
'after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backstage.example.com/api/soundcheck/campaigns/entities"
payload := strings.NewReader("{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backstage.example.com/api/soundcheck/campaigns/entities")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backstage.example.com/api/soundcheck/campaigns/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"edges": [
{
"node": {
"entityRef": "<string>",
"certified": true,
"checkStates": [
{
"checkId": "<string>",
"checkName": "<string>"
}
],
"entity": {}
}
}
]
}{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}Campaigns
Get campaign entities
Get a paginated list of entities for a campaign, enriched with certification status and check results. Exactly one of campaignId or campaignName must be provided. If checkStates is provided, a checkId or checkName must also be provided.
POST
/
campaigns
/
entities
Get campaign entities
curl --request POST \
--url https://backstage.example.com/api/soundcheck/campaigns/entities \
--header 'Content-Type: application/json' \
--data '
{
"campaignId": "<string>",
"campaignName": "<string>",
"checkId": "<string>",
"checkName": "<string>",
"checkStates": [],
"entityFilter": {},
"entityFields": [
"<string>"
],
"metadataAnnotations": [
"<string>"
],
"first": 123,
"after": "<string>"
}
'import requests
url = "https://backstage.example.com/api/soundcheck/campaigns/entities"
payload = {
"campaignId": "<string>",
"campaignName": "<string>",
"checkId": "<string>",
"checkName": "<string>",
"checkStates": [],
"entityFilter": {},
"entityFields": ["<string>"],
"metadataAnnotations": ["<string>"],
"first": 123,
"after": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
campaignId: '<string>',
campaignName: '<string>',
checkId: '<string>',
checkName: '<string>',
checkStates: [],
entityFilter: {},
entityFields: ['<string>'],
metadataAnnotations: ['<string>'],
first: 123,
after: '<string>'
})
};
fetch('https://backstage.example.com/api/soundcheck/campaigns/entities', 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://backstage.example.com/api/soundcheck/campaigns/entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaignId' => '<string>',
'campaignName' => '<string>',
'checkId' => '<string>',
'checkName' => '<string>',
'checkStates' => [
],
'entityFilter' => [
],
'entityFields' => [
'<string>'
],
'metadataAnnotations' => [
'<string>'
],
'first' => 123,
'after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backstage.example.com/api/soundcheck/campaigns/entities"
payload := strings.NewReader("{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backstage.example.com/api/soundcheck/campaigns/entities")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backstage.example.com/api/soundcheck/campaigns/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignId\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"checkId\": \"<string>\",\n \"checkName\": \"<string>\",\n \"checkStates\": [],\n \"entityFilter\": {},\n \"entityFields\": [\n \"<string>\"\n ],\n \"metadataAnnotations\": [\n \"<string>\"\n ],\n \"first\": 123,\n \"after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"edges": [
{
"node": {
"entityRef": "<string>",
"certified": true,
"checkStates": [
{
"checkId": "<string>",
"checkName": "<string>"
}
],
"entity": {}
}
}
]
}{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}Body
application/json
Exactly one of campaignId or campaignName must be provided. If checkStates is provided, checkId or checkName must also be provided.
⌘I