curl --request GET \
--url https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}', 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.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}",
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://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}"
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://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}")
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{
"best_practice_id": "<string>",
"name": "<string>",
"checking": "<string>",
"bucket": "hygiene",
"action": "<string>",
"site_impact_pp": 123,
"metric": "citeability",
"page_count": 123,
"pending_count": 123,
"reviewed_count": 123,
"staged_count": 123,
"deployed_count": 123,
"offset": 123,
"limit": 123,
"filtered_total": 123,
"pages": [
{
"opportunity_id": "<string>",
"target_url": "<string>",
"path": "<string>",
"state": "pending",
"expected_lift_pp": 123,
"run_id": "<string>",
"chunks": [
{
"chunk_id": "<string>",
"original_html": "<string>",
"optimized_html": "<string>",
"label": "<string>",
"verdict": "approved"
}
]
}
],
"site_impact_unavailable_reason": "not_in_scored_run"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Opportunity Type Detail
One opportunity type’s detail: the whole-type header (projected lift and per-state page counts) plus one paginated window of its affected pages, each with its pipeline state and the before/after content chunks inline.
Use state to filter the page window (all, pending, reviewed, staged, deployed) and limit/offset to page through it — the header counts always span the whole type. Returns 404 when the brand has no opportunities of this type.
curl --request GET \
--url https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}', 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.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}",
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://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}"
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://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrunchai.com/v1/{brand_id}/opportunities/by-type/{best_practice_id}")
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{
"best_practice_id": "<string>",
"name": "<string>",
"checking": "<string>",
"bucket": "hygiene",
"action": "<string>",
"site_impact_pp": 123,
"metric": "citeability",
"page_count": 123,
"pending_count": 123,
"reviewed_count": 123,
"staged_count": 123,
"deployed_count": 123,
"offset": 123,
"limit": 123,
"filtered_total": 123,
"pages": [
{
"opportunity_id": "<string>",
"target_url": "<string>",
"path": "<string>",
"state": "pending",
"expected_lift_pp": 123,
"run_id": "<string>",
"chunks": [
{
"chunk_id": "<string>",
"original_html": "<string>",
"optimized_html": "<string>",
"label": "<string>",
"verdict": "approved"
}
]
}
],
"site_impact_unavailable_reason": "not_in_scored_run"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Restrict the affected-page window to this pipeline state.
all, pending, reviewed, staged, deployed 1 <= x <= 100x >= 0Response
Successful Response
One opportunity type's detail view: catalog header, per-state counts, and a page of its
affected pages. The header and every count span the WHOLE type (independent of the state filter
and pagination); only pages is the sliced, state-filtered window that carries chunk diffs.
hygiene, transformation, enrichment citeability, retrievability Show child attributes
Show child attributes
not_in_scored_run, no_scored_run