Research és hivatkozásos összefoglalók
Kiválasztott kutatási korpusz áttekintésének olvasása
Determinisztikus darabszámok olvasása egy pontos lezárt korpuszhoz; a kiválasztott elemek nem jelentenek közönség- vagy piacméretet. agent:research szükséges.
POST /research-api/projects/overviewSzerződés ellenőrizve: · sha256:ab393e91e9b7f18a
Áttekintés
Determinisztikus darabszámok olvasása egy pontos lezárt korpuszhoz; a kiválasztott elemek nem jelentenek közönség- vagy piacméretet. agent:research szükséges.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
project_id | stringA szülőn belül kötelező |
|
project_revision | integerA szülőn belül kötelező |
|
corpus_snapshot_id | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"corpus_snapshot_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"workspace_id",
"project_id",
"project_revision",
"corpus_snapshot_id"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: currently authorized exact Research resource data.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
project_id | stringA szülőn belül kötelező |
|
project_revision | integerA szülőn belül kötelező |
|
corpus_snapshot_id | stringA szülőn belül kötelező |
|
method_version | stringA szülőn belül kötelező |
|
coverage | stringA szülőn belül kötelező |
|
evidence_count | integerA szülőn belül kötelező |
|
unique_items | integerA szülőn belül kötelező |
|
brand_union_count | integerA szülőn belül kötelező |
|
overlap_count | integerA szülőn belül kötelező |
|
brands | arrayA szülőn belül kötelező |
|
brands[] | objectOpcionális / elem | — |
brands[].id | stringA szülőn belül kötelező |
|
brands[].name | stringA szülőn belül kötelező |
|
brands[].matched_items | integerA szülőn belül kötelező |
|
brands[].observed_mention_share | number | nullA szülőn belül kötelező | — |
brands[].observed_mention_shareanyOf 1 | numberA szülőn belül kötelező |
|
brands[].observed_mention_shareanyOf 2 | nullA szülőn belül kötelező | — |
brands[].evidence | arrayA szülőn belül kötelező |
|
brands[].evidence[] | objectOpcionális / elem | — |
brands[].evidence[].evidence_id | stringA szülőn belül kötelező |
|
brands[].evidence[].revision | integerA szülőn belül kötelező |
|
languages | arrayA szülőn belül kötelező |
|
languages[] | objectOpcionális / elem | — |
languages[].language | string | nullA szülőn belül kötelező | — |
languages[].languageanyOf 1 | stringA szülőn belül kötelező |
|
languages[].languageanyOf 2 | nullA szülőn belül kötelező | — |
languages[].item_count | integerA szülőn belül kötelező |
|
platforms | arrayA szülőn belül kötelező |
|
platforms[] | objectOpcionális / elem | — |
platforms[].platform | string | nullA szülőn belül kötelező | — |
platforms[].platformanyOf 1 | stringA szülőn belül kötelező |
|
platforms[].platformanyOf 2 | nullA szülőn belül kötelező | — |
platforms[].item_count | integerA szülőn belül kötelező |
|
sources | arrayA szülőn belül kötelező |
|
sources[] | objectOpcionális / elem | — |
sources[].category | stringA szülőn belül kötelező |
|
sources[].item_count | integerA szülőn belül kötelező |
|
history | objectA szülőn belül kötelező | — |
history.eligible | booleanA szülőn belül kötelező |
|
history.reason | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"corpus_snapshot_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"method_version": {
"type": "string",
"const": "literal-mentions/v1"
},
"coverage": {
"type": "string",
"enum": [
"supplied_set",
"bounded_sample",
"partial"
]
},
"evidence_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unique_items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"brand_union_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"overlap_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"brands": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"matched_items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"observed_mention_share": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1
},
{
"type": "null"
}
]
},
"evidence": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"evidence_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"evidence_id",
"revision"
]
}
}
},
"required": [
"id",
"name",
"matched_items",
"observed_mention_share",
"evidence"
]
}
},
"languages": {
"maxItems": 501,
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 35
},
{
"type": "null"
}
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"language",
"item_count"
]
}
},
"platforms": {
"maxItems": 8,
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"anyOf": [
{
"type": "string",
"enum": [
"threads",
"instagram",
"facebook",
"youtube",
"x",
"reddit",
"web"
]
},
{
"type": "null"
}
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"platform",
"item_count"
]
}
},
"sources": {
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"your_accounts",
"public_posts",
"team_notes"
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"category",
"item_count"
]
}
},
"history": {
"type": "object",
"properties": {
"eligible": {
"type": "boolean",
"const": false
},
"reason": {
"type": "string",
"const": "insufficient_comparable_history"
}
},
"required": [
"eligible",
"reason"
]
}
},
"required": [
"project_id",
"project_revision",
"corpus_snapshot_id",
"method_version",
"coverage",
"evidence_count",
"unique_items",
"brand_union_count",
"overlap_count",
"brands",
"languages",
"platforms",
"sources",
"history"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. AI-ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /research-api/projects/overview < request.jsonSzintetikus válaszpélda
{
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"corpus_snapshot_id": "11111111-1111-4111-8111-111111111111",
"method_version": "literal-mentions/v1",
"coverage": "supplied_set",
"evidence_count": 0,
"unique_items": 0,
"brand_union_count": 0,
"overlap_count": 0,
"brands": [],
"languages": [],
"platforms": [],
"sources": [],
"history": {
"eligible": false,
"reason": "insufficient_comparable_history"
}
}